Skip to main content
POST
cURL

Body

application/json
gateway_name
string
required

Name of the gateway.

CID
string

The opaque session ID token. Required for 7.2 controllers only.

action
string

The API action to perform. Required for 7.2 controllers only.

address
string

IP addresses to ping.

interval
string

Time interval between pings.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype
string

Error type if the API failed.

reason
string

Failure reason if the API failed.

results

API response data

return
boolean

Whether the API returned successfully