Appliances

API used to manage appliances and their configurations.

List registered appliances

get/appliances
Request
query Parameters
cursor
string
Default: ""

String value pointing to the next page of results after the last request.

limit
integer <int32>
Default: 10

Limits the number of objects returned per page.

query
string
Default: ""

Provides the ability to see if any of multiple properties contains the given value. Properties include ID, Instance ID, Provider, TOS Version, DV Version, and Hostname

sortBy
string
Default: "ID"

Sorts the return list by the given property.

Enum: "ID" "instanceId" "dvVersion" "tosVersion" "provider" "hostName"
sortDirection
string
Default: "asc"

Sorts the return list in either ascending or descending order.

Enum: "asc" "desc"
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

401

Unauthorized

403

Forbidden

404

The appliance is not found.

Response samples
application/json
{
  • "totalCount": 0,
  • "next": "string",
  • "appliances": [
    ]
}

Search appliances

post/appliances/search
Request
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json

Search Filter

cursor
string
limit
integer <int32>
maxItems
integer <int32>
Array of objects (searchCriteria)
sortByObjectID
boolean
Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

The appliance is not found.

Request samples
application/json
{
  • "maxItems": 0,
  • "limit": 0,
  • "cursor": "string",
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "totalCount": 0,
  • "next": "string",
  • "appliances": [
    ]
}

Get appliance configuration

get/appliances/{id}
Request
path Parameters
id
required
integer <int64>

Appliance ID

header Parameters
api-version
required
string

API Version, e.g. v1

Value: "v1"
Responses
200

OK

401

Unauthorized

403

Forbidden

404

The appliance is not found.

Response samples
application/json
{
  • "ID": 0,
  • "instanceId": "string",
  • "provider": "string",
  • "hostName": "string",
  • "tosVersion": "string",
  • "dvVersion": "string",
  • "auxDv": {
    },
  • "providerMetadata": [
    ],
  • "features": {
    }
}

Rename Network Security appliance

post/appliances/{id}
Request
path Parameters
id
required
integer <int64>

Appliance ID

query Parameters
reboot
boolean

Reboots the appliance after changing hostname, if true.

header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json

Contains hostname to change appliance name to. highAvailability is ignored

object (HighAvailability)

High-availability setting

hostName
string

host name of the appliance

Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

The appliance is not found.

Request samples
application/json
{
  • "highAvailability": {
    },
  • "hostName": "string"
}
Response samples
application/json
{
  • "ID": 0,
  • "instanceId": "string",
  • "provider": "string",
  • "hostName": "string",
  • "tosVersion": "string",
  • "dvVersion": "string",
  • "auxDv": {
    },
  • "providerMetadata": [
    ],
  • "features": {
    }
}

Unregister appliance

delete/appliances/{id}
Request
path Parameters
id
required
integer <int64>

Appliance ID

header Parameters
api-version
required
string

API Version

Value: "v1"
delete-agent
string

Provides the ability to identify who is calling this API. This tag is used in the log message for unregistering the appliance. Default value is null, which doesn't log an 'agent' value

Responses
204

No Content

401

Unauthorized

403

Forbidden

404

The appliance is not found.

Set fallback state

post/appliances/{id}/fallback
Request
path Parameters
id
required
integer <int64>

Appliance ID

header Parameters
api-version
required
string

API Version, e.g. v1

Value: "v1"
Request Body schema: application/json

Configures whether the appliance inspects traffic or not. Setting the fallback state to 'true' causes the appliance to pass traffic through uninspected, 'false' causes the appliance to inspect traffic.

required
object (Fallback)

Fallback configuration

Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

The appliance is not found.

Request samples
application/json
{
  • "fallback": {
    }
}