Skip to main content
GET
cURL

Query Parameters

gateway_name
string
required

Gateway name.

service_name
enum<string>
required

Service to request.

Available options:
BGP_service,
CloudWatch,
Conduit,
Datadog,
NetFlow,
PKI,
rsyslog
service_list
boolean

Return a list of services for action.

action_list
boolean

Return a list of actions for services.

skip_wait
boolean

Skip waiting for conduit connection after restart (conduit service only).

action
string

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

CID
string

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

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