Update Railgun

PUT

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/railguns/{identifier}

Last modified:2022-12-16 13:48:32

Update a Railgun.

Request

Path Params

identifier

string

required

account_identifier

string

required

Body Params application/json

enabled

boolean

required

Flag to determine if the Railgun is accepting connections.

Default:

false

Example:

true

name

string

required

Readable identifier of the Railgun.

<= 160 characters

Example:

My Railgun.

upgrade_info

object (upgrade_info)

optional

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

download_link

string

optional

An HTTP link to download the latest Railgun binary.

Example:

https://www.cloudflare.com/downloads/railgun

latest_version

string

optional

Latest version of the Railgun receiver available to install.

Example:

1.0.0

Example

{
    "enabled": true,
    "name": "My Railgun.",
    "upgrade_info": {
        "download_link": "https://www.cloudflare.com/downloads/railgun",
        "latest_version": "1.0.0"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/accounts//railguns/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "enabled": true,
    "name": "My Railgun.",
    "upgrade_info": {
        "download_link": "https://www.cloudflare.com/downloads/railgun",
        "latest_version": "1.0.0"
    }
}'

Responses

🟢200Update Railgun response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {},
    "success": true
}

🟢200Update Railgun response failure

Modified at 2022-12-16 13:48:32

Railgun details

List Roles