List Railguns

List, search, sort and filter your Railguns.

application/json

Body

result

required

Any of

allOf {2}

array[object (railgun) {13}]

allOf {2}

One of

array[object (railgun) {13}]

object

activated_on

string <date-time>

activated_on

read-onlyrequired

When the Railgun was activated.

Example:

2014-01-02T02:20:00Z

activation_key

string

activation_key

read-onlyrequired

<= 32 characters

Example:

e4edc00281cb56ebac22c81be9bac8f3

build

string

build

read-onlyrequired

The build identifier for the Railgun receiver.

Example:

b1234

created_on

string <date-time>

railgun_components-schemas-created_on

read-onlyrequired

When the Railgun was created.

Example:

2014-01-01T05:20:00Z

enabled

boolean

railgun_components-schemas-enabled

required

Flag to determine if the Railgun is accepting connections.

Default:

false

Example:

true

string

railgun_components-schemas-identifier

read-onlyrequired

Railgun identifier tag.

<= 32 characters

Example:

e928d310693a83094309acf9ead50448

modified_on

string <date-time>

railgun_components-schemas-modified_on

read-onlyrequired

When the Railgun was last modified.

Example:

2014-01-01T05:20:00Z

name

string

railgun_components-schemas-name

required

Readable identifier of the Railgun.

<= 160 characters

Example:

My Railgun.

revision

string

revision

read-onlyrequired

The revision of the Railgun receiver.

Example:

123

status

enum<string>

railgun_components-schemas-status

read-onlyrequired

Status of the Railgun.

Allowed values:

initializingactive

Example:

active

upgrade_info

object

upgrade_info

optional

Defined when the Railgun version is out of date from the latest release from Cloudflare.

version

string

railgun_components-schemas-version

read-onlyrequired

The version of the Railgun receiver.

Example:

2.1

zones_connected

number

zones_connected

read-onlyrequired

The number of zones using this Railgun.

Example:

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": [
        {
            "activated_on": "2014-01-02T02:20:00Z",
            "activation_key": "e4edc00281cb56ebac22c81be9bac8f3",
            "build": "b1234",
            "created_on": "2014-01-01T05:20:00Z",
            "enabled": true,
            "id": "e928d310693a83094309acf9ead50448",
            "modified_on": "2014-01-01T05:20:00Z",
            "name": "My Railgun.",
            "revision": "123",
            "status": "active",
            "upgrade_info": {
                "download_link": "https://www.cloudflare.com/downloads/railgun",
                "latest_version": "1.0.0"
            },
            "version": "2.1",
            "zones_connected": 2
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses