List Connections

List connections associated with the Railgun.

application/json

Body

result

required

Any of

allOf {2}

array[object (schemas-connection) {5}]

allOf {2}

One of

array[object (schemas-connection) {5}]

object

created_on

string <date-time>

connection_components-schemas-created_on

read-onlyoptional

When the connection was created.

Example:

2017-06-14T00:00:00Z

enabled

boolean

connection_components-schemas-enabled

required

A value indicating whether the connection is enabled or not.

Default:

false

Example:

true

string

connection_components-schemas-identifier

read-onlyrequired

Connection identifier tag.

<= 32 characters

Example:

c4a7362d577a6c3019a474fd6f485821

modified_on

string <date-time>

connection_components-schemas-modified_on

read-onlyoptional

When the connection was last modified.

Example:

2017-06-14T05:20:00Z

zone

object

connection_components-schemas-zone

required

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "created_on": "2017-06-14T00:00:00Z",
            "enabled": true,
            "id": "c4a7362d577a6c3019a474fd6f485821",
            "modified_on": "2017-06-14T05:20:00Z",
            "zone": {
                "id": "023e105f4ecef8ad9ca31a8372d0c353",
                "name": "example.com"
            }
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses