Skip to main content
POST
cURL

Body

application/json
connection_name
string
required

Connection name.

gateway_name
string
required

Gateway name.

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.

disable_verbose
boolean

Enable verbose mode.

dst_interface
string

Connection interface name.

enable_verbose
boolean

Enable verbose mode.

reset_connection
boolean

Reset a single connection.

restart_service
boolean

Restart IPSec services.

run_analysis
boolean

Run tunnel analysis.

show_config
boolean

Show IPSEC config.

show_log
boolean

Show logs.

show_sa
boolean

Show security association status.

show_sp
boolean

Show security policy status.

src_interface
string

Gateway interface name.

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