RouterOS REST Schema v7.15 (all) Documentation

version v7.15
baseUri https://{host}:{port}/rest
protocols https, http
mediaType application/json

RouterOS RAML Schema for REST API

Schema is generated using /console/inspect from a RouterOS device, and interpreted into a schema based on the rules in Mikrotik REST documentation

/beep

/beep post

POST: /beep (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/beep post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/beep" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/certificate

/certificate get

GET: /certificate (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/certificate get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/certificate" \
	--user username:password

RESPONSE BODY

Type

array

/certificate put

PUT: /certificate (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/certificate put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/certificate" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /certificate/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add-scep post

POST: /certificate/add-scep (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add-scep post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/add-scep" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/card-reinstall post

POST: /certificate/card-reinstall (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/card-reinstall post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/card-reinstall" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/card-verify post

POST: /certificate/card-verify (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/card-verify post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/card-verify" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/create-certificate-request post

POST: /certificate/create-certificate-request (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/create-certificate-request post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/create-certificate-request" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/crl get

GET: /certificate/crl (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/crl get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/certificate/crl" \
	--user username:password

RESPONSE BODY

Type

array

/crl put

PUT: /certificate/crl (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/crl put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/certificate/crl" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /certificate/crl/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/crl/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/download post

POST: /certificate/crl/download (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/download post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/crl/download" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /certificate/crl/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/crl/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /certificate/crl/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/crl/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/flush post

POST: /certificate/crl/flush (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/flush post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/crl/flush" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /certificate/crl/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/crl/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /certificate/crl/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/certificate/crl/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /certificate/crl/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/certificate/crl/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /certificate/crl/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/certificate/crl/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /certificate/crl/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/crl/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /certificate/crl/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/crl/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /certificate/crl/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/crl/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /certificate/crl/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/crl/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /certificate/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable-ssl-certificate post

POST: /certificate/enable-ssl-certificate (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable-ssl-certificate post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/enable-ssl-certificate" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /certificate/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export-certificate post

POST: /certificate/export-certificate (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export-certificate post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/export-certificate" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /certificate/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /certificate/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /certificate/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/certificate/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /certificate/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/certificate/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /certificate/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/certificate/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/import post

POST: /certificate/import (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/import post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/import" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/issued-revoke post

POST: /certificate/issued-revoke (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/issued-revoke post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/issued-revoke" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /certificate/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /certificate/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /certificate/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/scep-renew post

POST: /certificate/scep-renew (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/scep-renew post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-renew" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/scep-server get

GET: /certificate/scep-server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/scep-server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/certificate/scep-server" \
	--user username:password

RESPONSE BODY

Type

array

/scep-server put

PUT: /certificate/scep-server (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/scep-server put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/certificate/scep-server" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /certificate/scep-server/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /certificate/scep-server/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /certificate/scep-server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /certificate/scep-server/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /certificate/scep-server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /certificate/scep-server/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /certificate/scep-server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /certificate/scep-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/certificate/scep-server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /certificate/scep-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/certificate/scep-server/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /certificate/scep-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/certificate/scep-server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/otp get

GET: /certificate/scep-server/otp (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/otp get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/certificate/scep-server/otp" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /certificate/scep-server/otp/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/otp/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/generate post

POST: /certificate/scep-server/otp/generate (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/generate post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/otp/generate" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /certificate/scep-server/otp/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/otp/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /certificate/scep-server/otp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/certificate/scep-server/otp/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /certificate/scep-server/otp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/certificate/scep-server/otp/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /certificate/scep-server/otp/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/otp/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /certificate/scep-server/otp/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/otp/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /certificate/scep-server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ra get

GET: /certificate/scep-server/ra (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ra get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/certificate/scep-server/ra" \
	--user username:password

RESPONSE BODY

Type

array

/ra put

PUT: /certificate/scep-server/ra (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ra put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/certificate/scep-server/ra" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /certificate/scep-server/ra/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/ra/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /certificate/scep-server/ra/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/ra/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /certificate/scep-server/ra/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/ra/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /certificate/scep-server/ra/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/ra/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /certificate/scep-server/ra/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/ra/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /certificate/scep-server/ra/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/ra/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /certificate/scep-server/ra/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/ra/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /certificate/scep-server/ra/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/certificate/scep-server/ra/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /certificate/scep-server/ra/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/certificate/scep-server/ra/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /certificate/scep-server/ra/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/certificate/scep-server/ra/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /certificate/scep-server/ra/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/ra/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /certificate/scep-server/ra/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/ra/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/renew post

POST: /certificate/scep-server/ra/renew (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/renew post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/ra/renew" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /certificate/scep-server/ra/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/ra/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /certificate/scep-server/ra/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/ra/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /certificate/scep-server/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/requests get

GET: /certificate/scep-server/requests (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/requests get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/certificate/scep-server/requests" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /certificate/scep-server/requests/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/requests/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /certificate/scep-server/requests/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/requests/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /certificate/scep-server/requests/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/certificate/scep-server/requests/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /certificate/scep-server/requests/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/certificate/scep-server/requests/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/grant post

POST: /certificate/scep-server/requests/grant (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/grant post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/requests/grant" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /certificate/scep-server/requests/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/requests/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /certificate/scep-server/requests/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/requests/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /certificate/scep-server/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /certificate/scep-server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/scep-server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /certificate/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /certificate/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/certificate/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /certificate/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /certificate/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /certificate/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /certificate/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/certificate/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /certificate/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/certificate/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /certificate/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /certificate/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/sign post

POST: /certificate/sign (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sign post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/sign" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/sign-certificate-request post

POST: /certificate/sign-certificate-request (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sign-certificate-request post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/sign-certificate-request" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /certificate/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/certificate/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/console

/clear-history post

POST: /console/clear-history (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/clear-history post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/console/clear-history" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /console/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/console/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/inspect post

POST: /console/inspect (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/inspect post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/console/inspect" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /console/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/console/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /console/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/console/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /console/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/console/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /console/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/console/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /console/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/console/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /console/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/console/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /console/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/console/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /console/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/console/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/convert

/convert post

POST: /convert (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/convert post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/convert" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/delay

/delay post

POST: /delay (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/delay post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/delay" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/deserialize

/deserialize post

POST: /deserialize (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/deserialize post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/deserialize" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disk

/disk get

GET: /disk (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disk get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/disk" \
	--user username:password

RESPONSE BODY

Type

array

/disk put

PUT: /disk (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disk put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/disk" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /disk/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /disk/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/copy post

POST: /disk/copy (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/copy post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/copy" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /disk/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /disk/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/eject-drive post

POST: /disk/eject-drive (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/eject-drive post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/eject-drive" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /disk/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /disk/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /disk/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/format-drive post

POST: /disk/format-drive (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/format-drive post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/format-drive" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /disk/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /disk/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/disk/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /disk/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/disk/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /disk/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/disk/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor-traffic post

POST: /disk/monitor-traffic (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor-traffic post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/monitor-traffic" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /disk/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /disk/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /disk/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /disk/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/scan post

POST: /disk/scan (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/scan post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/scan" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /disk/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /disk/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/disk/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /disk/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /disk/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /disk/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /disk/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/disk/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /disk/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/disk/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /disk/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /disk/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /disk/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/disk/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/do

/do post

POST: /do (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/do post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/do" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/environment

/print post

POST: /environment/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/environment/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/error

/error post

POST: /error (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/error post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/error" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/execute

/execute post

POST: /execute (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/execute post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/execute" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/file

/file get

GET: /file (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/file get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/file" \
	--user username:password

RESPONSE BODY

Type

array

/file put

PUT: /file (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/file put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/file" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /file/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/file/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /file/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/file/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /file/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/file/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /file/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/file/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /file/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/file/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /file/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/file/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /file/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/file/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /file/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/file/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/read post

POST: /file/read (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/read post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/file/read" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /file/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/file/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /file/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/file/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /file/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/file/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find

/find post

POST: /find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/for

/for post

POST: /for (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/for post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/for" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/foreach

/foreach post

POST: /foreach (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/foreach post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/foreach" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/global

/global post

POST: /global (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/global post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/global" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/grep

/grep post

POST: /grep (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/grep post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/grep" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/if

/if post

POST: /if (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/if post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/if" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/import

/import post

POST: /import (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/import post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/import" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface

/interface get

GET: /interface (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface" \
	--user username:password

RESPONSE BODY

Type

array

/6to4 get

GET: /interface/6to4 (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/6to4 get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/6to4" \
	--user username:password

RESPONSE BODY

Type

array

/6to4 put

PUT: /interface/6to4 (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/6to4 put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/6to4" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/6to4/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/6to4/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/6to4/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/6to4/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/6to4/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/6to4/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/6to4/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/6to4/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/6to4/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/6to4/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/6to4/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/6to4/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/6to4/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/6to4/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/6to4/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/6to4/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/6to4/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/6to4/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/6to4/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/6to4/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/6to4/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/6to4/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/6to4/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/6to4/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/6to4/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/6to4/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/6to4/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/6to4/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/6to4/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/6to4/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/6to4/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/6to4/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/blink post

POST: /interface/blink (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/blink post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/blink" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/bonding get

GET: /interface/bonding (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/bonding get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bonding" \
	--user username:password

RESPONSE BODY

Type

array

/bonding put

PUT: /interface/bonding (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/bonding put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/bonding" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/bonding/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/bonding/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/bonding/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/bonding/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/bonding/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/bonding/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/bonding/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bonding/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bonding/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bonding/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/bonding/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/bonding/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bonding/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bonding/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/bonding/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor-slaves post

POST: /interface/bonding/monitor-slaves (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor-slaves post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/monitor-slaves" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bonding/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/bonding/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/bonding/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bonding/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/bonding/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bonding/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/bridge get

GET: /interface/bridge (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/bridge get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge" \
	--user username:password

RESPONSE BODY

Type

array

/bridge put

PUT: /interface/bridge (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/bridge put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/bridge" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/bridge/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/calea get

GET: /interface/bridge/calea (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/calea get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/calea" \
	--user username:password

RESPONSE BODY

Type

array

/calea put

PUT: /interface/bridge/calea (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/calea put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/bridge/calea" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/bridge/calea/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/bridge/calea/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/bridge/calea/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/bridge/calea/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/bridge/calea/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/bridge/calea/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/bridge/calea/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/calea/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/calea/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/calea/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/bridge/calea/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/bridge/calea/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/calea/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/calea/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /interface/bridge/calea/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/calea/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/bridge/calea/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/bridge/calea/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /interface/bridge/calea/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /interface/bridge/calea/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/calea/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/bridge/calea/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/calea/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/bridge/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/bridge/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/bridge/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/bridge/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/bridge/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/filter get

GET: /interface/bridge/filter (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/filter get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/filter" \
	--user username:password

RESPONSE BODY

Type

array

/filter put

PUT: /interface/bridge/filter (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/filter put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/bridge/filter" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/bridge/filter/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/bridge/filter/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/bridge/filter/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/bridge/filter/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/bridge/filter/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/bridge/filter/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/bridge/filter/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/filter/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/filter/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/bridge/filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/bridge/filter/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/filter/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /interface/bridge/filter/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/filter/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/bridge/filter/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/bridge/filter/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /interface/bridge/filter/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /interface/bridge/filter/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/filter/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/bridge/filter/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/filter/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/bridge/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/bridge/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/bridge/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/host get

GET: /interface/bridge/host (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/host get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/host" \
	--user username:password

RESPONSE BODY

Type

array

/host put

PUT: /interface/bridge/host (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/host put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/bridge/host" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/bridge/host/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/host/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/bridge/host/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/host/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/bridge/host/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/host/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/bridge/host/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/host/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/bridge/host/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/host/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/bridge/host/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/host/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/bridge/host/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/host/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/host/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/host/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/host/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/host/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/bridge/host/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/bridge/host/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/host/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/host/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/host/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/host/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/bridge/host/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/host/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/bridge/host/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/host/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/host/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/host/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/bridge/host/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/host/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/mdb get

GET: /interface/bridge/mdb (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mdb get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/mdb" \
	--user username:password

RESPONSE BODY

Type

array

/mdb put

PUT: /interface/bridge/mdb (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mdb put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/bridge/mdb" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/bridge/mdb/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/mdb/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/bridge/mdb/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/mdb/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/bridge/mdb/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/mdb/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/bridge/mdb/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/mdb/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/bridge/mdb/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/mdb/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/bridge/mdb/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/mdb/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/bridge/mdb/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/mdb/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/mdb/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/mdb/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/mdb/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/mdb/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/bridge/mdb/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/bridge/mdb/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/mdb/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/mdb/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/mdb/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/mdb/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/bridge/mdb/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/mdb/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/bridge/mdb/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/mdb/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/mdb/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/mdb/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/bridge/mdb/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/mdb/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/bridge/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/msti get

GET: /interface/bridge/msti (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/msti get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/msti" \
	--user username:password

RESPONSE BODY

Type

array

/msti put

PUT: /interface/bridge/msti (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/msti put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/bridge/msti" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/bridge/msti/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/msti/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/bridge/msti/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/msti/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/bridge/msti/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/msti/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/bridge/msti/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/msti/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/bridge/msti/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/msti/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/bridge/msti/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/msti/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/bridge/msti/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/msti/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/msti/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/msti/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/msti/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/msti/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/bridge/msti/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/bridge/msti/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/msti/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/msti/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/bridge/msti/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/msti/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/msti/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/msti/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/bridge/msti/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/msti/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/bridge/msti/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/msti/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/msti/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/msti/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/nat get

GET: /interface/bridge/nat (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/nat get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/nat" \
	--user username:password

RESPONSE BODY

Type

array

/nat put

PUT: /interface/bridge/nat (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/nat put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/bridge/nat" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/bridge/nat/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/bridge/nat/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/bridge/nat/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/bridge/nat/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/bridge/nat/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/bridge/nat/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/bridge/nat/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/nat/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/nat/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/nat/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/bridge/nat/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/bridge/nat/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/nat/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/nat/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /interface/bridge/nat/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/nat/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/bridge/nat/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/bridge/nat/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /interface/bridge/nat/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /interface/bridge/nat/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/nat/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/bridge/nat/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/nat/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/port get

GET: /interface/bridge/port (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/port get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/port" \
	--user username:password

RESPONSE BODY

Type

array

/port put

PUT: /interface/bridge/port (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/port put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/bridge/port" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/bridge/port/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/bridge/port/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/bridge/port/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/bridge/port/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/bridge/port/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/bridge/port/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/bridge/port/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/port/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/port/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/bridge/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/bridge/port/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/port/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/bridge/port/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /interface/bridge/port/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/mst-override get

GET: /interface/bridge/port/mst-override (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mst-override get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/port/mst-override" \
	--user username:password

RESPONSE BODY

Type

array

/mst-override put

PUT: /interface/bridge/port/mst-override (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mst-override put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/bridge/port/mst-override" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/bridge/port/mst-override/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/mst-override/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/bridge/port/mst-override/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/mst-override/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/bridge/port/mst-override/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/mst-override/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/bridge/port/mst-override/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/mst-override/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/bridge/port/mst-override/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/mst-override/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/bridge/port/mst-override/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/mst-override/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/bridge/port/mst-override/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/mst-override/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/port/mst-override/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/mst-override/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/port/mst-override/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/port/mst-override/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/bridge/port/mst-override/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/bridge/port/mst-override/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/port/mst-override/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/port/mst-override/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/bridge/port/mst-override/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/mst-override/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/port/mst-override/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/mst-override/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/bridge/port/mst-override/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/mst-override/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/bridge/port/mst-override/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/mst-override/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/port/mst-override/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/mst-override/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/bridge/port/mst-override/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/mst-override/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/port/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/bridge/port/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/bridge/port/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/port/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/bridge/port/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/port-controller get

GET: /interface/bridge/port-controller (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/port-controller get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/port-controller" \
	--user username:password

RESPONSE BODY

Type

array

/device get

GET: /interface/bridge/port-controller/device (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/device get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/port-controller/device" \
	--user username:password

RESPONSE BODY

Type

array

/device put

PUT: /interface/bridge/port-controller/device (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/device put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/bridge/port-controller/device" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/bridge/port-controller/device/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/device/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/bridge/port-controller/device/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/device/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/bridge/port-controller/device/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/device/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/port-controller/device/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/device/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/port-controller/device/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/port-controller/device/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/bridge/port-controller/device/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/bridge/port-controller/device/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/port-controller/device/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/port-controller/device/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/bridge/port-controller/device/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/device/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/port-controller/device/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/device/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/bridge/port-controller/device/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/device/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/bridge/port-controller/device/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/device/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/port-controller/device/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/device/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/bridge/port-controller/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/bridge/port-controller/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/port-controller/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/port-controller/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/port-controller/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/port-controller/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/port-controller/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/port get

GET: /interface/bridge/port-controller/port (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/port get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/port-controller/port" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /interface/bridge/port-controller/port/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/port/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/bridge/port-controller/port/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/port/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/bridge/port-controller/port/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/port/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/port-controller/port/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/port/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/port-controller/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/port-controller/port/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/bridge/port-controller/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/bridge/port-controller/port/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/port-controller/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/port-controller/port/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/bridge/port-controller/port/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/port/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/poe get

GET: /interface/bridge/port-controller/port/poe (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/poe get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/port-controller/port/poe" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /interface/bridge/port-controller/port/poe/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/port/poe/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/port-controller/port/poe/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/port/poe/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/port-controller/port/poe/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/port-controller/port/poe/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/monitor post

POST: /interface/bridge/port-controller/port/poe/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/port/poe/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/port-controller/port/poe/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/port/poe/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/port-controller/port/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/port/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/bridge/port-controller/port/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/port/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/bridge/port-controller/port/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/port/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/port-controller/port/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/port/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/port-controller/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/port-controller/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-controller/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/port-extender get

GET: /interface/bridge/port-extender (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/port-extender get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/port-extender" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /interface/bridge/port-extender/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-extender/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/bridge/port-extender/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-extender/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/port-extender/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-extender/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/port-extender/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/port-extender/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/port-extender/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/port-extender/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/port-extender/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-extender/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/port-extender/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/port-extender/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/bridge/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/bridge/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /interface/bridge/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /interface/bridge/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/bridge/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/vlan get

GET: /interface/bridge/vlan (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vlan get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/vlan" \
	--user username:password

RESPONSE BODY

Type

array

/vlan put

PUT: /interface/bridge/vlan (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vlan put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/bridge/vlan" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/bridge/vlan/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/bridge/vlan/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/bridge/vlan/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/bridge/vlan/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/bridge/vlan/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/bridge/vlan/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/bridge/vlan/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/vlan/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/vlan/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/vlan/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/bridge/vlan/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/bridge/vlan/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/bridge/vlan/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/bridge/vlan/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/mvrp get

GET: /interface/bridge/vlan/mvrp (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mvrp get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/vlan/mvrp" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /interface/bridge/vlan/mvrp/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/mvrp/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/bridge/vlan/mvrp/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/mvrp/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/bridge/vlan/mvrp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/bridge/vlan/mvrp/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/vlan/mvrp/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/mvrp/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/bridge/vlan/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/bridge/vlan/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/bridge/vlan/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/bridge/vlan/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/bridge/vlan/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/detect-internet get

GET: /interface/detect-internet (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/detect-internet get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/detect-internet" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /interface/detect-internet/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/detect-internet/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/detect-internet/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/detect-internet/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/detect-internet/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/detect-internet/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/detect-internet/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/detect-internet/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/detect-internet/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/detect-internet/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/detect-internet/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/detect-internet/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/detect-internet/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/detect-internet/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/state get

GET: /interface/detect-internet/state (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/state get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/detect-internet/state" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /interface/detect-internet/state/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/detect-internet/state/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/detect-internet/state/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/detect-internet/state/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/detect-internet/state/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/detect-internet/state/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /interface/detect-internet/state/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/detect-internet/state/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/client get

GET: /interface/dot1x/client (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/client get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/dot1x/client" \
	--user username:password

RESPONSE BODY

Type

array

/client put

PUT: /interface/dot1x/client (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/client put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/dot1x/client" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/dot1x/client/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/client/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/dot1x/client/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/client/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/dot1x/client/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/client/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/dot1x/client/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/client/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/dot1x/client/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/client/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/dot1x/client/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/client/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/dot1x/client/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/client/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/dot1x/client/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/client/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/dot1x/client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/dot1x/client/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/dot1x/client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/dot1x/client/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/dot1x/client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/dot1x/client/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/dot1x/client/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/client/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/dot1x/client/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/client/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/dot1x/client/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/client/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/dot1x/client/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/client/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/dot1x/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/server get

GET: /interface/dot1x/server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/dot1x/server" \
	--user username:password

RESPONSE BODY

Type

array

/server put

PUT: /interface/dot1x/server (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/server put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/dot1x/server" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/active get

GET: /interface/dot1x/server/active (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/active get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/dot1x/server/active" \
	--user username:password

RESPONSE BODY

Type

array

/active put

PUT: /interface/dot1x/server/active (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/active put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/dot1x/server/active" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/dot1x/server/active/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/active/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/dot1x/server/active/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/active/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/dot1x/server/active/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/active/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/dot1x/server/active/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/dot1x/server/active/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/dot1x/server/active/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/dot1x/server/active/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/dot1x/server/active/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/active/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/dot1x/server/active/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/active/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/dot1x/server/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/dot1x/server/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/dot1x/server/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/dot1x/server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/dot1x/server/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/dot1x/server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/dot1x/server/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/dot1x/server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/dot1x/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/dot1x/server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/dot1x/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/dot1x/server/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/dot1x/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/dot1x/server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/dot1x/server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/dot1x/server/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/dot1x/server/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/dot1x/server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/state get

GET: /interface/dot1x/server/state (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/state get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/dot1x/server/state" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /interface/dot1x/server/state/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/state/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/dot1x/server/state/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/state/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/dot1x/server/state/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/dot1x/server/state/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /interface/dot1x/server/state/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/state/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/dot1x/server/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/dot1x/server/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/eoip get

GET: /interface/eoip (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/eoip get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/eoip" \
	--user username:password

RESPONSE BODY

Type

array

/eoip put

PUT: /interface/eoip (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/eoip put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/eoip" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/eoip/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoip/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/eoip/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoip/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/eoip/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoip/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/eoip/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoip/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/eoip/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoip/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/eoip/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoip/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/eoip/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoip/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/eoip/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoip/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/eoip/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/eoip/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/eoip/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/eoip/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/eoip/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/eoip/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/eoip/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoip/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/eoip/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoip/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/eoip/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoip/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/eoip/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoip/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/eoip/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoip/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/eoipv6 get

GET: /interface/eoipv6 (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/eoipv6 get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/eoipv6" \
	--user username:password

RESPONSE BODY

Type

array

/eoipv6 put

PUT: /interface/eoipv6 (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/eoipv6 put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/eoipv6" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/eoipv6/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoipv6/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/eoipv6/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoipv6/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/eoipv6/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoipv6/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/eoipv6/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoipv6/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/eoipv6/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoipv6/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/eoipv6/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoipv6/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/eoipv6/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoipv6/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/eoipv6/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoipv6/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/eoipv6/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/eoipv6/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/eoipv6/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/eoipv6/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/eoipv6/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/eoipv6/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/eoipv6/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoipv6/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/eoipv6/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoipv6/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/eoipv6/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoipv6/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/eoipv6/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoipv6/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/eoipv6/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/eoipv6/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ethernet get

GET: /interface/ethernet (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ethernet get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ethernet" \
	--user username:password

RESPONSE BODY

Type

array

/blink post

POST: /interface/ethernet/blink (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/blink post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/blink" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/cable-test post

POST: /interface/ethernet/cable-test (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/cable-test post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/cable-test" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/ethernet/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/ethernet/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/ethernet/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/ethernet/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/ethernet/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/ethernet/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/ethernet/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/ethernet/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ethernet/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/ethernet/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/ethernet/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/ethernet/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/ethernet/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/ethernet/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /interface/ethernet/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-mac-address post

POST: /interface/ethernet/reset-mac-address (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-mac-address post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/reset-mac-address" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/ethernet/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/ethernet/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ethernet/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/gre get

GET: /interface/gre (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/gre get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/gre" \
	--user username:password

RESPONSE BODY

Type

array

/gre put

PUT: /interface/gre (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/gre put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/gre" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/gre/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/gre/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/gre/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/gre/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/gre/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/gre/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/gre/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/gre/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/gre/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/gre/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/gre/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/gre/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/gre/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/gre/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/gre/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/gre/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/gre/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/gre/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/gre/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/gre6 get

GET: /interface/gre6 (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/gre6 get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/gre6" \
	--user username:password

RESPONSE BODY

Type

array

/gre6 put

PUT: /interface/gre6 (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/gre6 put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/gre6" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/gre6/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre6/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/gre6/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre6/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/gre6/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre6/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/gre6/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre6/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/gre6/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre6/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/gre6/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre6/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/gre6/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre6/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/gre6/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre6/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/gre6/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/gre6/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/gre6/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/gre6/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/gre6/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/gre6/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/gre6/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre6/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/gre6/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre6/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/gre6/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre6/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/gre6/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre6/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/gre6/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/gre6/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ipip get

GET: /interface/ipip (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ipip get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ipip" \
	--user username:password

RESPONSE BODY

Type

array

/ipip put

PUT: /interface/ipip (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ipip put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/ipip" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/ipip/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipip/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/ipip/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipip/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/ipip/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipip/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/ipip/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipip/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/ipip/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipip/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/ipip/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipip/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/ipip/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipip/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/ipip/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipip/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/ipip/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ipip/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/ipip/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/ipip/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/ipip/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/ipip/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/ipip/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipip/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/ipip/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipip/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/ipip/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipip/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/ipip/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipip/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/ipip/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipip/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ipipv6 get

GET: /interface/ipipv6 (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ipipv6 get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ipipv6" \
	--user username:password

RESPONSE BODY

Type

array

/ipipv6 put

PUT: /interface/ipipv6 (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ipipv6 put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/ipipv6" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/ipipv6/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipipv6/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/ipipv6/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipipv6/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/ipipv6/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipipv6/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/ipipv6/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipipv6/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/ipipv6/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipipv6/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/ipipv6/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipipv6/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/ipipv6/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipipv6/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/ipipv6/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipipv6/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/ipipv6/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ipipv6/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/ipipv6/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/ipipv6/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/ipipv6/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/ipipv6/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/ipipv6/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipipv6/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/ipipv6/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipipv6/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/ipipv6/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipipv6/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/ipipv6/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipipv6/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/ipipv6/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ipipv6/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/l2tp-client get

GET: /interface/l2tp-client (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/l2tp-client get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/l2tp-client" \
	--user username:password

RESPONSE BODY

Type

array

/l2tp-client put

PUT: /interface/l2tp-client (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/l2tp-client put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/l2tp-client" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/l2tp-client/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-client/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/l2tp-client/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-client/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/l2tp-client/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-client/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/l2tp-client/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-client/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/l2tp-client/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-client/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/l2tp-client/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-client/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/l2tp-client/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-client/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/l2tp-client/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-client/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/l2tp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/l2tp-client/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/l2tp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/l2tp-client/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/l2tp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/l2tp-client/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/l2tp-client/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-client/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/l2tp-client/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-client/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/l2tp-client/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-client/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/l2tp-client/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-client/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/l2tp-client/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-client/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/l2tp-ether get

GET: /interface/l2tp-ether (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/l2tp-ether get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/l2tp-ether" \
	--user username:password

RESPONSE BODY

Type

array

/l2tp-ether put

PUT: /interface/l2tp-ether (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/l2tp-ether put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/l2tp-ether" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/l2tp-ether/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-ether/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/l2tp-ether/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-ether/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/l2tp-ether/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-ether/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/l2tp-ether/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-ether/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/l2tp-ether/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-ether/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/l2tp-ether/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-ether/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/l2tp-ether/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-ether/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/l2tp-ether/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-ether/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/l2tp-ether/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/l2tp-ether/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/l2tp-ether/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/l2tp-ether/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/l2tp-ether/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/l2tp-ether/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/l2tp-ether/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-ether/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/l2tp-ether/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-ether/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/l2tp-ether/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-ether/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/l2tp-ether/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-ether/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/l2tp-ether/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-ether/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/l2tp-ether/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-ether/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/l2tp-server get

GET: /interface/l2tp-server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/l2tp-server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/l2tp-server" \
	--user username:password

RESPONSE BODY

Type

array

/l2tp-server put

PUT: /interface/l2tp-server (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/l2tp-server put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/l2tp-server" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/l2tp-server/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/l2tp-server/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/l2tp-server/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/l2tp-server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/l2tp-server/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/l2tp-server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/l2tp-server/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/l2tp-server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/l2tp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/l2tp-server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/l2tp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/l2tp-server/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/l2tp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/l2tp-server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/l2tp-server/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/l2tp-server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/l2tp-server/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/l2tp-server/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/server get

GET: /interface/l2tp-server/server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/l2tp-server/server" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /interface/l2tp-server/server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/l2tp-server/server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/l2tp-server/server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/l2tp-server/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/l2tp-server/server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/l2tp-server/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/l2tp-server/server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/l2tp-server/server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/l2tp-server/server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/l2tp-server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/l2tp-server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/list get

GET: /interface/list (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/list get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/list" \
	--user username:password

RESPONSE BODY

Type

array

/list put

PUT: /interface/list (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/list put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/list" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/list/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/list/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/list/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/list/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/list/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/list/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/list/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/list/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/list/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/member get

GET: /interface/list/member (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/member get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/list/member" \
	--user username:password

RESPONSE BODY

Type

array

/member put

PUT: /interface/list/member (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/member put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/list/member" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/list/member/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/member/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/list/member/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/member/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/list/member/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/member/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/list/member/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/member/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/list/member/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/member/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/list/member/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/member/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/list/member/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/member/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/list/member/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/member/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/list/member/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/list/member/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/list/member/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/list/member/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/list/member/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/list/member/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/list/member/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/member/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/list/member/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/member/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/list/member/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/member/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/list/member/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/member/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/list/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/list/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/list/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/list/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/list/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/lte get

GET: /interface/lte (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/lte get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/lte" \
	--user username:password

RESPONSE BODY

Type

array

/apn get

GET: /interface/lte/apn (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/apn get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/lte/apn" \
	--user username:password

RESPONSE BODY

Type

array

/apn put

PUT: /interface/lte/apn (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/apn put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/lte/apn" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/lte/apn/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/apn/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/lte/apn/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/apn/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/lte/apn/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/apn/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/lte/apn/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/apn/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/lte/apn/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/apn/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/lte/apn/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/apn/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/lte/apn/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/lte/apn/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/lte/apn/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/lte/apn/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/lte/apn/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/lte/apn/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/lte/apn/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/apn/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/lte/apn/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/apn/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/lte/apn/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/apn/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/lte/apn/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/apn/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/at-chat post

POST: /interface/lte/at-chat (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/at-chat post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/at-chat" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/cell-monitor post

POST: /interface/lte/cell-monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/cell-monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/cell-monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/lte/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/lte/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/lte/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/lte/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/activate-profile post

POST: /interface/lte/esim/activate-profile (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/activate-profile post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/esim/activate-profile" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/delete-profle post

POST: /interface/lte/esim/delete-profle (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/delete-profle post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/esim/delete-profle" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable-profle post

POST: /interface/lte/esim/enable-profle (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable-profle post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/esim/enable-profle" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/esim-id post

POST: /interface/lte/esim/esim-id (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/esim-id post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/esim/esim-id" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/list-profiles post

POST: /interface/lte/esim/list-profiles (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/list-profiles post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/esim/list-profiles" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/rename-profle post

POST: /interface/lte/esim/rename-profle (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rename-profle post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/esim/rename-profle" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/lte/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/lte/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/firmware-upgrade post

POST: /interface/lte/firmware-upgrade (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/firmware-upgrade post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/firmware-upgrade" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/lte/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/lte/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/lte/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/lte/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/lte/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/lte/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/lte/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/lte/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/lte/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/lte/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/lte/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/scan post

POST: /interface/lte/scan (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/scan post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/scan" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/lte/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /interface/lte/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/lte/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /interface/lte/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/lte/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/lte/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/lte/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/lte/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/lte/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/lte/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/lte/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/lte/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/show-capabilities post

POST: /interface/lte/show-capabilities (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/show-capabilities post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/show-capabilities" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/lte/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/lte/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/macsec get

GET: /interface/macsec (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/macsec get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/macsec" \
	--user username:password

RESPONSE BODY

Type

array

/macsec put

PUT: /interface/macsec (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/macsec put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/macsec" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/macsec/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/macsec/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/macsec/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/macsec/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/macsec/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/macsec/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/macsec/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/macsec/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/macsec/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/macsec/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/macsec/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/macsec/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/macsec/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/macsec/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/macsec/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/profile get

GET: /interface/macsec/profile (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/profile get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/macsec/profile" \
	--user username:password

RESPONSE BODY

Type

array

/profile put

PUT: /interface/macsec/profile (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/profile put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/macsec/profile" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/macsec/profile/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/profile/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/macsec/profile/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/profile/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/macsec/profile/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/profile/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/macsec/profile/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/profile/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/macsec/profile/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/profile/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/macsec/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/macsec/profile/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/macsec/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/macsec/profile/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/macsec/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/macsec/profile/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/macsec/profile/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/profile/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/macsec/profile/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/profile/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/macsec/profile/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/profile/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/macsec/profile/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/profile/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/macsec/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/macsec/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/macsec/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macsec/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/macvlan get

GET: /interface/macvlan (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/macvlan get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/macvlan" \
	--user username:password

RESPONSE BODY

Type

array

/macvlan put

PUT: /interface/macvlan (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/macvlan put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/macvlan" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/macvlan/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macvlan/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/macvlan/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macvlan/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/macvlan/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macvlan/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/macvlan/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macvlan/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/macvlan/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macvlan/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/macvlan/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macvlan/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/macvlan/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macvlan/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/macvlan/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macvlan/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/macvlan/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/macvlan/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/macvlan/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/macvlan/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/macvlan/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/macvlan/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/macvlan/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macvlan/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/macvlan/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macvlan/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/macvlan/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macvlan/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/macvlan/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/macvlan/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/mesh get

GET: /interface/mesh (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mesh get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/mesh" \
	--user username:password

RESPONSE BODY

Type

array

/mesh put

PUT: /interface/mesh (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mesh put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/mesh" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/mesh/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/mesh/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/mesh/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/mesh/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/mesh/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/mesh/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/fdb get

GET: /interface/mesh/fdb (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/fdb get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/mesh/fdb" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /interface/mesh/fdb/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/fdb/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/mesh/fdb/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/fdb/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/mesh/fdb/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/mesh/fdb/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /interface/mesh/fdb/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/fdb/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/mesh/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/mesh/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/mesh/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/mesh/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/mesh/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/mesh/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/mesh/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/mesh/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/port get

GET: /interface/mesh/port (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/port get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/mesh/port" \
	--user username:password

RESPONSE BODY

Type

array

/port put

PUT: /interface/mesh/port (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/port put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/mesh/port" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/mesh/port/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/port/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/mesh/port/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/port/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/mesh/port/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/port/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/mesh/port/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/port/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/mesh/port/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/port/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/mesh/port/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/port/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/mesh/port/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/port/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/mesh/port/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/port/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/mesh/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/mesh/port/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/mesh/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/mesh/port/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/mesh/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/mesh/port/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/mesh/port/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/port/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/mesh/port/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/port/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/mesh/port/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/port/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/mesh/port/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/port/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/mesh/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/mesh/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/mesh/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/mesh/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/traceroute post

POST: /interface/mesh/traceroute (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/traceroute post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/mesh/traceroute" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor-traffic post

POST: /interface/monitor-traffic (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor-traffic post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/monitor-traffic" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ovpn-client get

GET: /interface/ovpn-client (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ovpn-client get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ovpn-client" \
	--user username:password

RESPONSE BODY

Type

array

/ovpn-client put

PUT: /interface/ovpn-client (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ovpn-client put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/ovpn-client" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/ovpn-client/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-client/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/ovpn-client/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-client/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/ovpn-client/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-client/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/ovpn-client/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-client/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/ovpn-client/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-client/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/ovpn-client/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-client/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/ovpn-client/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-client/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/ovpn-client/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-client/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/ovpn-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ovpn-client/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/ovpn-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/ovpn-client/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/ovpn-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/ovpn-client/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/import-ovpn-configuration post

POST: /interface/ovpn-client/import-ovpn-configuration (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/import-ovpn-configuration post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-client/import-ovpn-configuration" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/ovpn-client/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-client/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/ovpn-client/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-client/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/ovpn-client/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-client/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/ovpn-client/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-client/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/ovpn-client/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-client/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ovpn-server get

GET: /interface/ovpn-server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ovpn-server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ovpn-server" \
	--user username:password

RESPONSE BODY

Type

array

/ovpn-server put

PUT: /interface/ovpn-server (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ovpn-server put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/ovpn-server" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/ovpn-server/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/ovpn-server/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/ovpn-server/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/ovpn-server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/ovpn-server/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/ovpn-server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/ovpn-server/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/ovpn-server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/ovpn-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ovpn-server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/ovpn-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/ovpn-server/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/ovpn-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/ovpn-server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/ovpn-server/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/ovpn-server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/ovpn-server/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/ovpn-server/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/server get

GET: /interface/ovpn-server/server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ovpn-server/server" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /interface/ovpn-server/server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/ovpn-server/server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export-client-configuration post

POST: /interface/ovpn-server/server/export-client-configuration (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export-client-configuration post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/server/export-client-configuration" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/ovpn-server/server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/ovpn-server/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ovpn-server/server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/ovpn-server/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/ovpn-server/server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/ovpn-server/server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/ovpn-server/server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/ovpn-server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ovpn-server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ppp-client get

GET: /interface/ppp-client (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ppp-client get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ppp-client" \
	--user username:password

RESPONSE BODY

Type

array

/ppp-client put

PUT: /interface/ppp-client (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ppp-client put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/ppp-client" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/ppp-client/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/at-chat post

POST: /interface/ppp-client/at-chat (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/at-chat post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/at-chat" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/ppp-client/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/ppp-client/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/ppp-client/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/ppp-client/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/ppp-client/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/ppp-client/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/firmware-upgrade post

POST: /interface/ppp-client/firmware-upgrade (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/firmware-upgrade post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/firmware-upgrade" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/ppp-client/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/ppp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ppp-client/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/ppp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/ppp-client/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/ppp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/ppp-client/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/info post

POST: /interface/ppp-client/info (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/info post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/info" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/ppp-client/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/ppp-client/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/ppp-client/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/ppp-client/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/scan post

POST: /interface/ppp-client/scan (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/scan post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/scan" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/ppp-client/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-client/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ppp-server get

GET: /interface/ppp-server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ppp-server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ppp-server" \
	--user username:password

RESPONSE BODY

Type

array

/ppp-server put

PUT: /interface/ppp-server (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ppp-server put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/ppp-server" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/ppp-server/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-server/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/ppp-server/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-server/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/ppp-server/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-server/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/ppp-server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/ppp-server/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-server/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/ppp-server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/ppp-server/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-server/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/ppp-server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/ppp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/ppp-server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/ppp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/ppp-server/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/ppp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/ppp-server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/ppp-server/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-server/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/ppp-server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/ppp-server/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-server/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/ppp-server/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-server/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/ppp-server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/ppp-server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/pppoe-client get

GET: /interface/pppoe-client (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pppoe-client get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/pppoe-client" \
	--user username:password

RESPONSE BODY

Type

array

/pppoe-client put

PUT: /interface/pppoe-client (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pppoe-client put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/pppoe-client" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/pppoe-client/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/pppoe-client/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/pppoe-client/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/pppoe-client/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/pppoe-client/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/pppoe-client/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/pppoe-client/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/pppoe-client/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/pppoe-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/pppoe-client/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/pppoe-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/pppoe-client/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/pppoe-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/pppoe-client/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/pppoe-client/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/pppoe-client/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/pppoe-client/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/pppoe-client/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/scan post

POST: /interface/pppoe-client/scan (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/scan post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/scan" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/pppoe-client/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/pppoe-client/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-client/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/pppoe-server get

GET: /interface/pppoe-server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pppoe-server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/pppoe-server" \
	--user username:password

RESPONSE BODY

Type

array

/pppoe-server put

PUT: /interface/pppoe-server (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pppoe-server put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/pppoe-server" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/pppoe-server/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/pppoe-server/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/pppoe-server/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/pppoe-server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/pppoe-server/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/pppoe-server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/pppoe-server/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/pppoe-server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/pppoe-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/pppoe-server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/pppoe-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/pppoe-server/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/pppoe-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/pppoe-server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/pppoe-server/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/pppoe-server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/pppoe-server/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/pppoe-server/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/server get

GET: /interface/pppoe-server/server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/pppoe-server/server" \
	--user username:password

RESPONSE BODY

Type

array

/server put

PUT: /interface/pppoe-server/server (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/server put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/pppoe-server/server" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/pppoe-server/server/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/server/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/pppoe-server/server/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/server/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/pppoe-server/server/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/server/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/pppoe-server/server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/pppoe-server/server/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/server/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/pppoe-server/server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/pppoe-server/server/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/server/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/pppoe-server/server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/pppoe-server/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/pppoe-server/server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/pppoe-server/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/pppoe-server/server/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/pppoe-server/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/pppoe-server/server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/pppoe-server/server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/pppoe-server/server/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/server/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/pppoe-server/server/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/server/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/pppoe-server/server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/pppoe-server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pppoe-server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/pptp-client get

GET: /interface/pptp-client (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pptp-client get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/pptp-client" \
	--user username:password

RESPONSE BODY

Type

array

/pptp-client put

PUT: /interface/pptp-client (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pptp-client put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/pptp-client" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/pptp-client/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-client/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/pptp-client/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-client/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/pptp-client/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-client/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/pptp-client/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-client/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/pptp-client/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-client/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/pptp-client/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-client/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/pptp-client/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-client/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/pptp-client/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-client/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/pptp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/pptp-client/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/pptp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/pptp-client/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/pptp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/pptp-client/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/pptp-client/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-client/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/pptp-client/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-client/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/pptp-client/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-client/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/pptp-client/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-client/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/pptp-client/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-client/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/pptp-server get

GET: /interface/pptp-server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pptp-server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/pptp-server" \
	--user username:password

RESPONSE BODY

Type

array

/pptp-server put

PUT: /interface/pptp-server (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pptp-server put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/pptp-server" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/pptp-server/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/pptp-server/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/pptp-server/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/pptp-server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/pptp-server/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/pptp-server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/pptp-server/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/pptp-server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/pptp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/pptp-server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/pptp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/pptp-server/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/pptp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/pptp-server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/pptp-server/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/pptp-server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/pptp-server/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/pptp-server/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/server get

GET: /interface/pptp-server/server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/pptp-server/server" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /interface/pptp-server/server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/pptp-server/server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/pptp-server/server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/pptp-server/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/pptp-server/server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/pptp-server/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/pptp-server/server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/pptp-server/server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/pptp-server/server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/pptp-server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/pptp-server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /interface/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/sstp-client get

GET: /interface/sstp-client (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sstp-client get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/sstp-client" \
	--user username:password

RESPONSE BODY

Type

array

/sstp-client put

PUT: /interface/sstp-client (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sstp-client put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/sstp-client" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/sstp-client/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-client/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/sstp-client/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-client/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/sstp-client/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-client/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/sstp-client/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-client/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/sstp-client/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-client/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/sstp-client/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-client/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/sstp-client/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-client/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/sstp-client/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-client/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/sstp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/sstp-client/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/sstp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/sstp-client/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/sstp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/sstp-client/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/sstp-client/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-client/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/sstp-client/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-client/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/sstp-client/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-client/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/sstp-client/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-client/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/sstp-client/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-client/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/sstp-server get

GET: /interface/sstp-server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sstp-server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/sstp-server" \
	--user username:password

RESPONSE BODY

Type

array

/sstp-server put

PUT: /interface/sstp-server (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sstp-server put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/sstp-server" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/sstp-server/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/sstp-server/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/sstp-server/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/sstp-server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/sstp-server/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/sstp-server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/sstp-server/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/sstp-server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/sstp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/sstp-server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/sstp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/sstp-server/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/sstp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/sstp-server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/sstp-server/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/sstp-server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/sstp-server/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/sstp-server/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/server get

GET: /interface/sstp-server/server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/sstp-server/server" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /interface/sstp-server/server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/sstp-server/server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/sstp-server/server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/sstp-server/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/sstp-server/server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/sstp-server/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/sstp-server/server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/sstp-server/server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/sstp-server/server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/sstp-server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/sstp-server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/veth get

GET: /interface/veth (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/veth get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/veth" \
	--user username:password

RESPONSE BODY

Type

array

/veth put

PUT: /interface/veth (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/veth put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/veth" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/veth/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/veth/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/veth/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/veth/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/veth/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/veth/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/veth/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/veth/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/veth/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/veth/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/veth/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/veth/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/veth/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/veth/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/veth/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/veth/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/veth/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/veth/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/veth/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/veth/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/veth/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/veth/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/veth/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/veth/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/veth/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/veth/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/veth/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/veth/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/veth/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/veth/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/vlan get

GET: /interface/vlan (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vlan get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vlan" \
	--user username:password

RESPONSE BODY

Type

array

/vlan put

PUT: /interface/vlan (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vlan put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/vlan" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/vlan/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vlan/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/vlan/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vlan/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/vlan/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vlan/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/vlan/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vlan/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/vlan/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vlan/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/vlan/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vlan/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/vlan/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vlan/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/vlan/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vlan/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/vlan/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vlan/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/vlan/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/vlan/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/vlan/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/vlan/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/vlan/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vlan/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/vlan/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vlan/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/vlan/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vlan/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/vlan/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vlan/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/vpls get

GET: /interface/vpls (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vpls get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vpls" \
	--user username:password

RESPONSE BODY

Type

array

/vpls put

PUT: /interface/vpls (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vpls put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/vpls" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/vpls/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vpls/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/vpls/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vpls/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/vpls/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vpls/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/vpls/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vpls/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/vpls/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vpls/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/vpls/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vpls/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/vpls/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vpls/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/vpls/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vpls/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/vpls/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vpls/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/vpls/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/vpls/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/vpls/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/vpls/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/vpls/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vpls/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/vpls/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vpls/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/vpls/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vpls/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/vpls/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vpls/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/vpls/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vpls/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/vpls/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vpls/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/vrrp get

GET: /interface/vrrp (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vrrp get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vrrp" \
	--user username:password

RESPONSE BODY

Type

array

/vrrp put

PUT: /interface/vrrp (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vrrp put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/vrrp" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/vrrp/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vrrp/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/vrrp/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vrrp/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/vrrp/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vrrp/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/vrrp/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vrrp/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/vrrp/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vrrp/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/vrrp/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vrrp/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/vrrp/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vrrp/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/vrrp/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vrrp/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/vrrp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vrrp/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/vrrp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/vrrp/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/vrrp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/vrrp/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/vrrp/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vrrp/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/vrrp/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vrrp/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/vrrp/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vrrp/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/vrrp/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vrrp/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/vxlan get

GET: /interface/vxlan (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vxlan get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vxlan" \
	--user username:password

RESPONSE BODY

Type

array

/vxlan put

PUT: /interface/vxlan (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vxlan put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/vxlan" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/vxlan/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/vxlan/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/vxlan/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/vxlan/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/vxlan/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/vxlan/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/fdb get

GET: /interface/vxlan/fdb (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/fdb get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vxlan/fdb" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /interface/vxlan/fdb/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/fdb/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/vxlan/fdb/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/fdb/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/vxlan/fdb/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vxlan/fdb/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /interface/vxlan/fdb/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/fdb/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/vxlan/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/vxlan/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/vxlan/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vxlan/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/vxlan/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/vxlan/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/vxlan/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/vxlan/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/vxlan/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/vxlan/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/vxlan/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/vxlan/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/vxlan/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/vteps get

GET: /interface/vxlan/vteps (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vteps get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vxlan/vteps" \
	--user username:password

RESPONSE BODY

Type

array

/vteps put

PUT: /interface/vxlan/vteps (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vteps put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/vxlan/vteps" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/vxlan/vteps/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/vxlan/vteps/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/vxlan/vteps/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/vxlan/vteps/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/vxlan/vteps/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/vxlan/vteps/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vxlan/vteps/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/vxlan/vteps/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/vxlan/vteps/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/vxlan/vteps/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/vxlan/vteps/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/vxlan/vteps/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/vxlan/vteps/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/vxlan/vteps/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/vxlan/vteps/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/wifi get

GET: /interface/wifi (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

values

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/wifi get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi" \
	--user username:password

RESPONSE BODY

Type

array

/wifi put

PUT: /interface/wifi (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/wifi put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/wifi" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/aaa get

GET: /interface/wifi/aaa (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/aaa get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/aaa" \
	--user username:password

RESPONSE BODY

Type

array

/aaa put

PUT: /interface/wifi/aaa (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/aaa put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/wifi/aaa" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/wifi/aaa/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/aaa/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/wifi/aaa/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/aaa/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/wifi/aaa/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/aaa/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/wifi/aaa/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/aaa/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/wifi/aaa/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/aaa/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/wifi/aaa/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/aaa/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/wifi/aaa/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/aaa/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/aaa/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/aaa/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/aaa/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/aaa/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/wifi/aaa/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/wifi/aaa/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wifi/aaa/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wifi/aaa/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/aaa/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/aaa/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/wifi/aaa/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/aaa/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/wifi/aaa/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/aaa/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wifi/aaa/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/aaa/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/wifi/aaa/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/aaa/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/access-list get

GET: /interface/wifi/access-list (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/access-list get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/access-list" \
	--user username:password

RESPONSE BODY

Type

array

/access-list put

PUT: /interface/wifi/access-list (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/access-list put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/wifi/access-list" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/wifi/access-list/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/access-list/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/wifi/access-list/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/access-list/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/wifi/access-list/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/access-list/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/wifi/access-list/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/access-list/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/wifi/access-list/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/access-list/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/wifi/access-list/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/access-list/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/wifi/access-list/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/access-list/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/access-list/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/access-list/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/access-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/access-list/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/wifi/access-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/wifi/access-list/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wifi/access-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wifi/access-list/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /interface/wifi/access-list/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/access-list/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/access-list/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/access-list/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/wifi/access-list/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/access-list/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/wifi/access-list/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/access-list/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wifi/access-list/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/access-list/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/wifi/access-list/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/access-list/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/wifi/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/cap get

GET: /interface/wifi/cap (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/cap get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/cap" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /interface/wifi/cap/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/cap/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/wifi/cap/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/cap/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/cap/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/cap/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/cap/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/cap/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wifi/cap/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wifi/cap/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/cap/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/cap/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wifi/cap/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/cap/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/capsman get

GET: /interface/wifi/capsman (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/capsman get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/capsman" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /interface/wifi/capsman/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/capsman/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/wifi/capsman/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/capsman/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/capsman/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/capsman/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/capsman/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/capsman/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wifi/capsman/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wifi/capsman/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/capsman/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/capsman/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remote-cap get

GET: /interface/wifi/capsman/remote-cap (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remote-cap get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/capsman/remote-cap" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /interface/wifi/capsman/remote-cap/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/capsman/remote-cap/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/capsman/remote-cap/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/capsman/remote-cap/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/capsman/remote-cap/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/capsman/remote-cap/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/wifi/capsman/remote-cap/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/wifi/capsman/remote-cap/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/capsman/remote-cap/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/capsman/remote-cap/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/provision post

POST: /interface/wifi/capsman/remote-cap/provision (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/provision post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/capsman/remote-cap/provision" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/wifi/capsman/remote-cap/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/capsman/remote-cap/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set-identity post

POST: /interface/wifi/capsman/remote-cap/set-identity (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set-identity post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/capsman/remote-cap/set-identity" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/upgrade post

POST: /interface/wifi/capsman/remote-cap/upgrade (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/upgrade post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/capsman/remote-cap/upgrade" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wifi/capsman/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/capsman/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/channel get

GET: /interface/wifi/channel (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/channel get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/channel" \
	--user username:password

RESPONSE BODY

Type

array

/channel put

PUT: /interface/wifi/channel (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/channel put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/wifi/channel" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/wifi/channel/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/channel/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/wifi/channel/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/channel/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/wifi/channel/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/channel/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/wifi/channel/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/channel/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/wifi/channel/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/channel/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/wifi/channel/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/channel/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/wifi/channel/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/channel/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/channel/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/channel/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/channel/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/channel/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/wifi/channel/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/wifi/channel/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wifi/channel/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wifi/channel/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/channel/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/channel/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/wifi/channel/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/channel/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/wifi/channel/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/channel/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wifi/channel/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/channel/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/wifi/channel/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/channel/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/wifi/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/configuration get

GET: /interface/wifi/configuration (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

values

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/configuration get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/configuration" \
	--user username:password

RESPONSE BODY

Type

array

/configuration put

PUT: /interface/wifi/configuration (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/configuration put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/wifi/configuration" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/wifi/configuration/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/configuration/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/wifi/configuration/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/configuration/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/wifi/configuration/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/configuration/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/wifi/configuration/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/configuration/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/wifi/configuration/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/configuration/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/wifi/configuration/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/configuration/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/wifi/configuration/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/configuration/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/configuration/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/configuration/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/configuration/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/configuration/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/wifi/configuration/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/wifi/configuration/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wifi/configuration/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wifi/configuration/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/configuration/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/configuration/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/wifi/configuration/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/configuration/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/wifi/configuration/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/configuration/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wifi/configuration/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/configuration/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/wifi/configuration/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/configuration/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/datapath get

GET: /interface/wifi/datapath (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/datapath get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/datapath" \
	--user username:password

RESPONSE BODY

Type

array

/datapath put

PUT: /interface/wifi/datapath (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/datapath put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/wifi/datapath" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/wifi/datapath/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/datapath/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/wifi/datapath/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/datapath/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/wifi/datapath/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/datapath/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/wifi/datapath/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/datapath/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/wifi/datapath/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/datapath/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/wifi/datapath/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/datapath/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/wifi/datapath/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/datapath/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/datapath/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/datapath/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/datapath/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/datapath/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/wifi/datapath/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/wifi/datapath/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wifi/datapath/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wifi/datapath/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/datapath/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/datapath/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/wifi/datapath/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/datapath/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/wifi/datapath/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/datapath/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wifi/datapath/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/datapath/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/wifi/datapath/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/datapath/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/devel post

POST: /interface/wifi/devel (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/devel post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/devel" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/wifi/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/wifi/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/wifi/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/wifi/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/wifi/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/flat-snoop post

POST: /interface/wifi/flat-snoop (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/flat-snoop post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/flat-snoop" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/frequency-scan post

POST: /interface/wifi/frequency-scan (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/frequency-scan post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/frequency-scan" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/wifi/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/wifi/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wifi/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wifi/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interworking get

GET: /interface/wifi/interworking (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interworking get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/interworking" \
	--user username:password

RESPONSE BODY

Type

array

/interworking put

PUT: /interface/wifi/interworking (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interworking put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/wifi/interworking" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/wifi/interworking/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/interworking/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/wifi/interworking/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/interworking/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/wifi/interworking/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/interworking/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/wifi/interworking/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/interworking/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/wifi/interworking/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/interworking/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/wifi/interworking/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/interworking/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/wifi/interworking/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/interworking/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/interworking/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/interworking/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/interworking/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/interworking/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/wifi/interworking/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/wifi/interworking/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wifi/interworking/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wifi/interworking/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/interworking/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/interworking/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/wifi/interworking/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/interworking/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/wifi/interworking/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/interworking/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wifi/interworking/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/interworking/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/wifi/interworking/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/interworking/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /interface/wifi/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/provisioning get

GET: /interface/wifi/provisioning (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/provisioning get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/provisioning" \
	--user username:password

RESPONSE BODY

Type

array

/provisioning put

PUT: /interface/wifi/provisioning (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/provisioning put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/wifi/provisioning" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/wifi/provisioning/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/provisioning/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/wifi/provisioning/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/provisioning/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/wifi/provisioning/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/provisioning/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/wifi/provisioning/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/provisioning/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/wifi/provisioning/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/provisioning/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/wifi/provisioning/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/provisioning/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/wifi/provisioning/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/provisioning/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/provisioning/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/provisioning/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/provisioning/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/provisioning/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/wifi/provisioning/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/wifi/provisioning/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wifi/provisioning/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wifi/provisioning/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /interface/wifi/provisioning/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/provisioning/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/provisioning/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/provisioning/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/wifi/provisioning/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/provisioning/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/wifi/provisioning/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/provisioning/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wifi/provisioning/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/provisioning/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/wifi/provisioning/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/provisioning/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/radio get

GET: /interface/wifi/radio (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/radio get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/radio" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /interface/wifi/radio/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/radio/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/radio/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/radio/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/radio/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/radio/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/radio/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/radio/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/provision post

POST: /interface/wifi/radio/provision (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/provision post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/radio/provision" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reg-info post

POST: /interface/wifi/radio/reg-info (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reg-info post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/radio/reg-info" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/wifi/radio/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/radio/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/registration-table get

GET: /interface/wifi/registration-table (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/registration-table get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/registration-table" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /interface/wifi/registration-table/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/registration-table/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/wifi/registration-table/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/registration-table/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/registration-table/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/registration-table/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/registration-table/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/registration-table/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/wifi/registration-table/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/wifi/registration-table/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/registration-table/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/registration-table/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/wifi/registration-table/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/registration-table/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/wifi/registration-table/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/registration-table/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/wifi/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/wifi/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/scan post

POST: /interface/wifi/scan (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/scan post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/scan" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/security get

GET: /interface/wifi/security (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/security get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/security" \
	--user username:password

RESPONSE BODY

Type

array

/security put

PUT: /interface/wifi/security (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/security put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/wifi/security" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/wifi/security/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/security/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/wifi/security/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/security/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/wifi/security/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/security/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/wifi/security/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/security/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/wifi/security/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/security/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/wifi/security/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/security/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/wifi/security/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/security/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/security/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/security/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/security/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/security/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/wifi/security/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/wifi/security/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wifi/security/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wifi/security/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/security/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/security/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/wifi/security/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/security/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/wifi/security/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/security/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wifi/security/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/security/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/wifi/security/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/security/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wifi/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/sniffer post

POST: /interface/wifi/sniffer (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sniffer post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/sniffer" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/steering get

GET: /interface/wifi/steering (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/steering get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/steering" \
	--user username:password

RESPONSE BODY

Type

array

/steering put

PUT: /interface/wifi/steering (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/steering put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/wifi/steering" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/wifi/steering/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/wifi/steering/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/wifi/steering/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/wifi/steering/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/wifi/steering/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/wifi/steering/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/wifi/steering/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/steering/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/steering/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/steering/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/wifi/steering/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/wifi/steering/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wifi/steering/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wifi/steering/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/neighbor-group get

GET: /interface/wifi/steering/neighbor-group (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/neighbor-group get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/steering/neighbor-group" \
	--user username:password

RESPONSE BODY

Type

array

/comment post

POST: /interface/wifi/steering/neighbor-group/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/neighbor-group/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/wifi/steering/neighbor-group/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/neighbor-group/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/wifi/steering/neighbor-group/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/neighbor-group/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wifi/steering/neighbor-group/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/neighbor-group/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wifi/steering/neighbor-group/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wifi/steering/neighbor-group/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wifi/steering/neighbor-group/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wifi/steering/neighbor-group/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/steering/neighbor-group/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/neighbor-group/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/wifi/steering/neighbor-group/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/neighbor-group/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wifi/steering/neighbor-group/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/neighbor-group/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wifi/steering/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/wifi/steering/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/wifi/steering/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wifi/steering/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/wifi/steering/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/steering/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /interface/wifi/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/wps-client post

POST: /interface/wifi/wps-client (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/wps-client post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/wps-client" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/wps-push-button post

POST: /interface/wifi/wps-push-button (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/wps-push-button post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wifi/wps-push-button" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/wireguard get

GET: /interface/wireguard (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/wireguard get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wireguard" \
	--user username:password

RESPONSE BODY

Type

array

/wireguard put

PUT: /interface/wireguard (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/wireguard put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/wireguard" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/wireguard/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/wireguard/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/wireguard/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/wireguard/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/wireguard/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/wireguard/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/wireguard/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wireguard/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wireguard/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wireguard/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/wireguard/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/wireguard/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wireguard/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wireguard/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/peers get

GET: /interface/wireguard/peers (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/peers get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wireguard/peers" \
	--user username:password

RESPONSE BODY

Type

array

/peers put

PUT: /interface/wireguard/peers (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/peers put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/wireguard/peers" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /interface/wireguard/peers/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/peers/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /interface/wireguard/peers/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/peers/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /interface/wireguard/peers/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/peers/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /interface/wireguard/peers/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/peers/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /interface/wireguard/peers/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/peers/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/wireguard/peers/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/peers/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /interface/wireguard/peers/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/peers/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /interface/wireguard/peers/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/peers/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/wireguard/peers/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/wireguard/peers/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/wireguard/peers/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/wireguard/peers/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/wireguard/peers/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/wireguard/peers/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /interface/wireguard/peers/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/peers/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wireguard/peers/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/peers/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/wireguard/peers/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/peers/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/wireguard/peers/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/peers/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wireguard/peers/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/peers/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/show-client-config post

POST: /interface/wireguard/peers/show-client-config (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/show-client-config post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/peers/show-client-config" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /interface/wireguard/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /interface/wireguard/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /interface/wireguard/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /interface/wireguard/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/wg-export post

POST: /interface/wireguard/wg-export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/wg-export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/wg-export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/wg-import post

POST: /interface/wireguard/wg-import (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/wg-import post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/wireguard/wg-import" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /interface/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ip

/address get

GET: /ip/address (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/address get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/address" \
	--user username:password

RESPONSE BODY

Type

array

/address put

PUT: /ip/address (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/address put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/address" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/address/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/address/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/address/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/address/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/address/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/address/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/address/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/address/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/address/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/address/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/address/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/address/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/address/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/address/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/address/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/address/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/address/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/address/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/address/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/address/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/address/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/address/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/address/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/address/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/address/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/address/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/address/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/address/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/address/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/address/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/arp get

GET: /ip/arp (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/arp get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/arp" \
	--user username:password

RESPONSE BODY

Type

array

/arp put

PUT: /ip/arp (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/arp put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/arp" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/arp/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/arp/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/arp/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/arp/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/arp/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/arp/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/arp/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/arp/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/arp/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/arp/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/arp/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/arp/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/arp/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/arp/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/arp/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/arp/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/arp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/arp/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/arp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/arp/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/arp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/arp/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/arp/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/arp/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/arp/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/arp/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/arp/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/arp/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/arp/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/arp/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/cloud get

GET: /ip/cloud (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/cloud get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/cloud" \
	--user username:password

RESPONSE BODY

Type

array

/advanced get

GET: /ip/cloud/advanced (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/advanced get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/cloud/advanced" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/cloud/advanced/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/cloud/advanced/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/cloud/advanced/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/cloud/advanced/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/cloud/advanced/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/cloud/advanced/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/cloud/advanced/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/cloud/advanced/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/cloud/advanced/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/cloud/advanced/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/cloud/advanced/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/cloud/advanced/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/cloud/advanced/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/cloud/advanced/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/cloud/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/cloud/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/cloud/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/cloud/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/force-update post

POST: /ip/cloud/force-update (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/force-update post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/cloud/force-update" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/cloud/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/cloud/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/cloud/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/cloud/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/cloud/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/cloud/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/cloud/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/cloud/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/cloud/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/cloud/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/dhcp-client get

GET: /ip/dhcp-client (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dhcp-client get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-client" \
	--user username:password

RESPONSE BODY

Type

array

/dhcp-client put

PUT: /ip/dhcp-client (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dhcp-client put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/dhcp-client" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/dhcp-client/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/dhcp-client/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/dhcp-client/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/dhcp-client/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/dhcp-client/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/dhcp-client/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/dhcp-client/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dhcp-client/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dhcp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-client/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/dhcp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/dhcp-client/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/dhcp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/dhcp-client/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/option get

GET: /ip/dhcp-client/option (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/option get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-client/option" \
	--user username:password

RESPONSE BODY

Type

array

/option put

PUT: /ip/dhcp-client/option (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/option put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/dhcp-client/option" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/dhcp-client/option/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/option/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/dhcp-client/option/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/option/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/dhcp-client/option/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/option/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/dhcp-client/option/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/option/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dhcp-client/option/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/option/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dhcp-client/option/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-client/option/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/dhcp-client/option/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/dhcp-client/option/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/dhcp-client/option/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/dhcp-client/option/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/dhcp-client/option/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/option/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/dhcp-client/option/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/option/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/dhcp-client/option/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/option/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/dhcp-client/option/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/option/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/dhcp-client/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/release post

POST: /ip/dhcp-client/release (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/release post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/release" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/dhcp-client/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/renew post

POST: /ip/dhcp-client/renew (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/renew post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/renew" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/dhcp-client/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/dhcp-client/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/dhcp-client/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-client/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/dhcp-relay get

GET: /ip/dhcp-relay (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dhcp-relay get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-relay" \
	--user username:password

RESPONSE BODY

Type

array

/dhcp-relay put

PUT: /ip/dhcp-relay (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dhcp-relay put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/dhcp-relay" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/dhcp-relay/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-relay/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/dhcp-relay/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-relay/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/dhcp-relay/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-relay/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/dhcp-relay/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-relay/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/dhcp-relay/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-relay/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/dhcp-relay/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-relay/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dhcp-relay/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-relay/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dhcp-relay/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-relay/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/dhcp-relay/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/dhcp-relay/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/dhcp-relay/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/dhcp-relay/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /ip/dhcp-relay/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-relay/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/dhcp-relay/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-relay/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/dhcp-relay/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-relay/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/dhcp-relay/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-relay/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ip/dhcp-relay/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-relay/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/dhcp-relay/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-relay/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/dhcp-relay/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-relay/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/dhcp-server get

GET: /ip/dhcp-server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dhcp-server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server" \
	--user username:password

RESPONSE BODY

Type

array

/dhcp-server put

PUT: /ip/dhcp-server (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dhcp-server put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/dhcp-server" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/dhcp-server/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/alert get

GET: /ip/dhcp-server/alert (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/alert get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/alert" \
	--user username:password

RESPONSE BODY

Type

array

/alert put

PUT: /ip/dhcp-server/alert (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/alert put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/dhcp-server/alert" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/dhcp-server/alert/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/alert/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/dhcp-server/alert/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/alert/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/dhcp-server/alert/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/alert/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/dhcp-server/alert/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/alert/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/dhcp-server/alert/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/alert/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/dhcp-server/alert/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/alert/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/dhcp-server/alert/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/alert/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dhcp-server/alert/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/alert/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dhcp-server/alert/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/alert/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/dhcp-server/alert/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/dhcp-server/alert/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/dhcp-server/alert/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/dhcp-server/alert/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/dhcp-server/alert/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/alert/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/dhcp-server/alert/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/alert/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/dhcp-server/alert/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/alert/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-alert post

POST: /ip/dhcp-server/alert/reset-alert (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-alert post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/alert/reset-alert" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/dhcp-server/alert/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/alert/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/dhcp-server/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/config get

GET: /ip/dhcp-server/config (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/config get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/config" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/dhcp-server/config/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/config/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/dhcp-server/config/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/config/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dhcp-server/config/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/config/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dhcp-server/config/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/config/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/dhcp-server/config/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/dhcp-server/config/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/dhcp-server/config/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/config/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/dhcp-server/config/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/config/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/dhcp-server/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/dhcp-server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/dhcp-server/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/dhcp-server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/dhcp-server/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dhcp-server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dhcp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/dhcp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/dhcp-server/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/dhcp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/dhcp-server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/lease get

GET: /ip/dhcp-server/lease (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/lease get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/lease" \
	--user username:password

RESPONSE BODY

Type

array

/lease put

PUT: /ip/dhcp-server/lease (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/lease put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/dhcp-server/lease" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/dhcp-server/lease/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/check-status post

POST: /ip/dhcp-server/lease/check-status (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/check-status post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/check-status" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/dhcp-server/lease/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/dhcp-server/lease/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/dhcp-server/lease/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/dhcp-server/lease/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/dhcp-server/lease/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/dhcp-server/lease/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dhcp-server/lease/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dhcp-server/lease/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/lease/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/dhcp-server/lease/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/dhcp-server/lease/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/dhcp-server/lease/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/dhcp-server/lease/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/make-static post

POST: /ip/dhcp-server/lease/make-static (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/make-static post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/make-static" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/dhcp-server/lease/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/dhcp-server/lease/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/dhcp-server/lease/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/dhcp-server/lease/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/dhcp-server/lease/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/lease/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/matcher get

GET: /ip/dhcp-server/matcher (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/matcher get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/matcher" \
	--user username:password

RESPONSE BODY

Type

array

/matcher put

PUT: /ip/dhcp-server/matcher (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/matcher put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/dhcp-server/matcher" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/dhcp-server/matcher/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/matcher/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/dhcp-server/matcher/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/matcher/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/dhcp-server/matcher/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/matcher/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/dhcp-server/matcher/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/matcher/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/dhcp-server/matcher/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/matcher/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/dhcp-server/matcher/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/matcher/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dhcp-server/matcher/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/matcher/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dhcp-server/matcher/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/matcher/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/dhcp-server/matcher/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/dhcp-server/matcher/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/dhcp-server/matcher/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/dhcp-server/matcher/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/dhcp-server/matcher/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/matcher/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/dhcp-server/matcher/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/matcher/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/dhcp-server/matcher/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/matcher/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/dhcp-server/matcher/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/matcher/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/network get

GET: /ip/dhcp-server/network (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/network get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/network" \
	--user username:password

RESPONSE BODY

Type

array

/network put

PUT: /ip/dhcp-server/network (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/network put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/dhcp-server/network" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/dhcp-server/network/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/network/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/dhcp-server/network/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/network/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/dhcp-server/network/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/network/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/dhcp-server/network/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/network/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/dhcp-server/network/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/network/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dhcp-server/network/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/network/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dhcp-server/network/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/network/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/dhcp-server/network/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/dhcp-server/network/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/dhcp-server/network/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/dhcp-server/network/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/dhcp-server/network/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/network/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/dhcp-server/network/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/network/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/dhcp-server/network/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/network/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/dhcp-server/network/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/network/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/dhcp-server/network/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/network/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/option get

GET: /ip/dhcp-server/option (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/option get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/option" \
	--user username:password

RESPONSE BODY

Type

array

/option put

PUT: /ip/dhcp-server/option (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/option put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/dhcp-server/option" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/dhcp-server/option/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/dhcp-server/option/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/dhcp-server/option/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/dhcp-server/option/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dhcp-server/option/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dhcp-server/option/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/option/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/dhcp-server/option/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/dhcp-server/option/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/dhcp-server/option/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/dhcp-server/option/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/dhcp-server/option/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/dhcp-server/option/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/dhcp-server/option/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/dhcp-server/option/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/sets get

GET: /ip/dhcp-server/option/sets (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sets get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/option/sets" \
	--user username:password

RESPONSE BODY

Type

array

/sets put

PUT: /ip/dhcp-server/option/sets (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sets put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/dhcp-server/option/sets" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/dhcp-server/option/sets/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/sets/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/dhcp-server/option/sets/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/sets/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/dhcp-server/option/sets/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/sets/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/dhcp-server/option/sets/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/sets/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dhcp-server/option/sets/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/sets/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dhcp-server/option/sets/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dhcp-server/option/sets/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/dhcp-server/option/sets/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/dhcp-server/option/sets/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/dhcp-server/option/sets/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/dhcp-server/option/sets/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/dhcp-server/option/sets/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/sets/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/dhcp-server/option/sets/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/sets/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/dhcp-server/option/sets/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/sets/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/dhcp-server/option/sets/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/option/sets/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/dhcp-server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/dhcp-server/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/dhcp-server/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/dhcp-server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/setup post

POST: /ip/dhcp-server/setup (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/setup post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dhcp-server/setup" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/dns get

GET: /ip/dns (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dns get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dns" \
	--user username:password

RESPONSE BODY

Type

array

/adlist get

GET: /ip/dns/adlist (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/adlist get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dns/adlist" \
	--user username:password

RESPONSE BODY

Type

array

/adlist put

PUT: /ip/dns/adlist (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/adlist put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/dns/adlist" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/dns/adlist/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/adlist/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/dns/adlist/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/adlist/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/dns/adlist/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/adlist/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/dns/adlist/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/adlist/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/dns/adlist/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/adlist/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/dns/adlist/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/adlist/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/dns/adlist/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/adlist/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dns/adlist/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/adlist/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dns/adlist/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dns/adlist/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/dns/adlist/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/dns/adlist/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/dns/adlist/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/dns/adlist/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/pause post

POST: /ip/dns/adlist/pause (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pause post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/adlist/pause" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/dns/adlist/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/adlist/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reload post

POST: /ip/dns/adlist/reload (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reload post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/adlist/reload" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/dns/adlist/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/adlist/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/dns/adlist/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/adlist/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/dns/adlist/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/adlist/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/cache get

GET: /ip/dns/cache (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/cache get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dns/cache" \
	--user username:password

RESPONSE BODY

Type

array

/all get

GET: /ip/dns/cache/all (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/all get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dns/cache/all" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /ip/dns/cache/all/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/cache/all/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dns/cache/all/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/cache/all/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dns/cache/all/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dns/cache/all/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /ip/dns/cache/all/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/cache/all/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/dns/cache/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/cache/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/flush post

POST: /ip/dns/cache/flush (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/flush post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/cache/flush" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dns/cache/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/cache/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dns/cache/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dns/cache/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /ip/dns/cache/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/cache/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/dns/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/dns/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dns/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dns/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dns/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/dns/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/dns/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/dns/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/dns/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/static get

GET: /ip/dns/static (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/static get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dns/static" \
	--user username:password

RESPONSE BODY

Type

array

/static put

PUT: /ip/dns/static (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/static put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/dns/static" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/dns/static/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/static/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/dns/static/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/static/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/dns/static/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/static/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/dns/static/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/static/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/dns/static/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/static/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/dns/static/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/static/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/dns/static/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/static/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/dns/static/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/static/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/dns/static/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/dns/static/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/dns/static/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/dns/static/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/dns/static/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/dns/static/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/dns/static/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/static/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/dns/static/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/static/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/dns/static/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/static/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/dns/static/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/static/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/dns/static/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/dns/static/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/address-list get

GET: /ip/firewall/address-list (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/address-list get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/address-list" \
	--user username:password

RESPONSE BODY

Type

array

/address-list put

PUT: /ip/firewall/address-list (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/address-list put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/firewall/address-list" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/firewall/address-list/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/address-list/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/firewall/address-list/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/address-list/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/firewall/address-list/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/address-list/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/firewall/address-list/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/address-list/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/firewall/address-list/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/address-list/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/firewall/address-list/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/address-list/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/firewall/address-list/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/address-list/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/firewall/address-list/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/address-list/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/firewall/address-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/address-list/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/firewall/address-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/firewall/address-list/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/firewall/address-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/firewall/address-list/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/firewall/address-list/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/address-list/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/firewall/address-list/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/address-list/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/firewall/address-list/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/address-list/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/firewall/address-list/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/address-list/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/calea get

GET: /ip/firewall/calea (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/calea get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/calea" \
	--user username:password

RESPONSE BODY

Type

array

/calea put

PUT: /ip/firewall/calea (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/calea put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/firewall/calea" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/firewall/calea/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/firewall/calea/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/firewall/calea/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/firewall/calea/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/firewall/calea/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/firewall/calea/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/firewall/calea/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/firewall/calea/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/firewall/calea/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/calea/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/firewall/calea/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/firewall/calea/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/firewall/calea/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/firewall/calea/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/firewall/calea/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/firewall/calea/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/firewall/calea/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/firewall/calea/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ip/firewall/calea/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /ip/firewall/calea/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/firewall/calea/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/firewall/calea/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/calea/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/connection get

GET: /ip/firewall/connection (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/connection get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/connection" \
	--user username:password

RESPONSE BODY

Type

array

/export post

POST: /ip/firewall/connection/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/connection/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/firewall/connection/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/connection/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/firewall/connection/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/connection/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/firewall/connection/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/connection/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/firewall/connection/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/firewall/connection/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/firewall/connection/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/connection/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/firewall/connection/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/connection/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/tracking get

GET: /ip/firewall/connection/tracking (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/tracking get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/connection/tracking" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/firewall/connection/tracking/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/connection/tracking/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/firewall/connection/tracking/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/connection/tracking/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/firewall/connection/tracking/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/connection/tracking/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/firewall/connection/tracking/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/connection/tracking/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/firewall/connection/tracking/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/firewall/connection/tracking/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/firewall/connection/tracking/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/connection/tracking/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/firewall/connection/tracking/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/connection/tracking/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/firewall/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/filter get

GET: /ip/firewall/filter (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/filter get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/filter" \
	--user username:password

RESPONSE BODY

Type

array

/filter put

PUT: /ip/firewall/filter (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/filter put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/firewall/filter" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/firewall/filter/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/firewall/filter/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/firewall/filter/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/firewall/filter/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/firewall/filter/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/firewall/filter/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/firewall/filter/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/firewall/filter/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/firewall/filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/filter/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/firewall/filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/firewall/filter/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/firewall/filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/firewall/filter/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/firewall/filter/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/firewall/filter/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/firewall/filter/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/firewall/filter/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ip/firewall/filter/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /ip/firewall/filter/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/firewall/filter/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/firewall/filter/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/filter/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/layer7-protocol get

GET: /ip/firewall/layer7-protocol (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/layer7-protocol get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/layer7-protocol" \
	--user username:password

RESPONSE BODY

Type

array

/layer7-protocol put

PUT: /ip/firewall/layer7-protocol (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/layer7-protocol put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/firewall/layer7-protocol" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/firewall/layer7-protocol/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/layer7-protocol/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/firewall/layer7-protocol/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/layer7-protocol/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/firewall/layer7-protocol/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/layer7-protocol/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/firewall/layer7-protocol/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/layer7-protocol/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/firewall/layer7-protocol/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/layer7-protocol/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/firewall/layer7-protocol/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/layer7-protocol/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/firewall/layer7-protocol/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/layer7-protocol/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/firewall/layer7-protocol/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/firewall/layer7-protocol/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/firewall/layer7-protocol/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/firewall/layer7-protocol/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/firewall/layer7-protocol/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/layer7-protocol/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/firewall/layer7-protocol/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/layer7-protocol/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/firewall/layer7-protocol/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/layer7-protocol/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/firewall/layer7-protocol/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/layer7-protocol/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/mangle get

GET: /ip/firewall/mangle (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mangle get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/mangle" \
	--user username:password

RESPONSE BODY

Type

array

/mangle put

PUT: /ip/firewall/mangle (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mangle put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/firewall/mangle" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/firewall/mangle/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/firewall/mangle/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/firewall/mangle/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/firewall/mangle/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/firewall/mangle/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/firewall/mangle/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/firewall/mangle/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/firewall/mangle/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/firewall/mangle/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/mangle/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/firewall/mangle/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/firewall/mangle/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/firewall/mangle/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/firewall/mangle/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/firewall/mangle/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/firewall/mangle/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/firewall/mangle/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/firewall/mangle/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ip/firewall/mangle/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /ip/firewall/mangle/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/firewall/mangle/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/firewall/mangle/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/mangle/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/nat get

GET: /ip/firewall/nat (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/nat get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/nat" \
	--user username:password

RESPONSE BODY

Type

array

/nat put

PUT: /ip/firewall/nat (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/nat put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/firewall/nat" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/firewall/nat/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/firewall/nat/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/firewall/nat/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/firewall/nat/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/firewall/nat/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/firewall/nat/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/firewall/nat/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/firewall/nat/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/firewall/nat/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/nat/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/firewall/nat/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/firewall/nat/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/firewall/nat/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/firewall/nat/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/firewall/nat/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/firewall/nat/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/firewall/nat/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/firewall/nat/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ip/firewall/nat/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /ip/firewall/nat/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/firewall/nat/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/firewall/nat/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/nat/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/raw get

GET: /ip/firewall/raw (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/raw get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/raw" \
	--user username:password

RESPONSE BODY

Type

array

/raw put

PUT: /ip/firewall/raw (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/raw put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/firewall/raw" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/firewall/raw/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/firewall/raw/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/firewall/raw/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/firewall/raw/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/firewall/raw/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/firewall/raw/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/firewall/raw/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/firewall/raw/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/firewall/raw/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/raw/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/firewall/raw/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/firewall/raw/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/firewall/raw/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/firewall/raw/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/firewall/raw/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/firewall/raw/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/firewall/raw/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/firewall/raw/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ip/firewall/raw/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /ip/firewall/raw/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/firewall/raw/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/firewall/raw/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/raw/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/service-port get

GET: /ip/firewall/service-port (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/service-port get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/service-port" \
	--user username:password

RESPONSE BODY

Type

array

/disable post

POST: /ip/firewall/service-port/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/service-port/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/firewall/service-port/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/service-port/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/firewall/service-port/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/service-port/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/firewall/service-port/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/service-port/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/firewall/service-port/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/service-port/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/firewall/service-port/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/service-port/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/firewall/service-port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/firewall/service-port/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/firewall/service-port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/firewall/service-port/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/firewall/service-port/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/service-port/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/firewall/service-port/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/service-port/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/firewall/service-port/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/firewall/service-port/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/hotspot get

GET: /ip/hotspot (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/hotspot get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot" \
	--user username:password

RESPONSE BODY

Type

array

/hotspot put

PUT: /ip/hotspot (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/hotspot put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/hotspot" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/active get

GET: /ip/hotspot/active (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/active get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/active" \
	--user username:password

RESPONSE BODY

Type

array

/active put

PUT: /ip/hotspot/active (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/active put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/hotspot/active" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/hotspot/active/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/active/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/hotspot/active/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/active/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/hotspot/active/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/active/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/hotspot/active/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/active/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/hotspot/active/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/active/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/hotspot/active/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/active/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/hotspot/active/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/hotspot/active/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/hotspot/active/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/hotspot/active/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

POST: /ip/hotspot/active/login (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/active/login" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/hotspot/active/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/active/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/hotspot/active/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/active/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/hotspot/active/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/active/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/hotspot/active/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/active/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/hotspot/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

GET: /ip/hotspot/cookie (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/cookie" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /ip/hotspot/cookie/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/cookie/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/hotspot/cookie/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/cookie/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/hotspot/cookie/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/cookie/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/hotspot/cookie/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/hotspot/cookie/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/hotspot/cookie/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/cookie/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/hotspot/cookie/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/cookie/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/hotspot/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/hotspot/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/hotspot/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/hotspot/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/hotspot/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/hotspot/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/hotspot/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/hotspot/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/hotspot/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/hotspot/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/hotspot/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/host get

GET: /ip/hotspot/host (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/host get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/host" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /ip/hotspot/host/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/host/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/hotspot/host/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/host/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/hotspot/host/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/host/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/hotspot/host/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/hotspot/host/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/make-binding post

POST: /ip/hotspot/host/make-binding (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/make-binding post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/host/make-binding" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/hotspot/host/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/host/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/hotspot/host/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/host/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/hotspot/host/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/host/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ip-binding get

GET: /ip/hotspot/ip-binding (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ip-binding get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/ip-binding" \
	--user username:password

RESPONSE BODY

Type

array

/ip-binding put

PUT: /ip/hotspot/ip-binding (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ip-binding put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/hotspot/ip-binding" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/hotspot/ip-binding/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/ip-binding/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/hotspot/ip-binding/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/ip-binding/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/hotspot/ip-binding/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/ip-binding/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/hotspot/ip-binding/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/ip-binding/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/hotspot/ip-binding/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/ip-binding/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/hotspot/ip-binding/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/ip-binding/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/hotspot/ip-binding/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/ip-binding/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/hotspot/ip-binding/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/ip-binding/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/hotspot/ip-binding/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/ip-binding/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/hotspot/ip-binding/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/hotspot/ip-binding/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/hotspot/ip-binding/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/hotspot/ip-binding/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/hotspot/ip-binding/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/ip-binding/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/hotspot/ip-binding/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/ip-binding/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/hotspot/ip-binding/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/ip-binding/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/hotspot/ip-binding/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/ip-binding/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/hotspot/ip-binding/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/ip-binding/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/hotspot/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/profile get

GET: /ip/hotspot/profile (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/profile get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/profile" \
	--user username:password

RESPONSE BODY

Type

array

/profile put

PUT: /ip/hotspot/profile (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/profile put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/hotspot/profile" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/hotspot/profile/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/profile/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/hotspot/profile/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/profile/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/hotspot/profile/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/profile/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/hotspot/profile/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/profile/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/hotspot/profile/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/profile/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/hotspot/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/profile/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/hotspot/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/hotspot/profile/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/hotspot/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/hotspot/profile/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/hotspot/profile/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/profile/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/hotspot/profile/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/profile/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/hotspot/profile/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/profile/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/hotspot/profile/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/profile/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/hotspot/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/hotspot/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-html post

POST: /ip/hotspot/reset-html (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-html post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/reset-html" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/service-port get

GET: /ip/hotspot/service-port (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/service-port get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/service-port" \
	--user username:password

RESPONSE BODY

Type

array

/disable post

POST: /ip/hotspot/service-port/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/service-port/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/hotspot/service-port/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/service-port/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/hotspot/service-port/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/service-port/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/hotspot/service-port/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/service-port/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/hotspot/service-port/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/service-port/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/hotspot/service-port/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/service-port/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/hotspot/service-port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/service-port/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/hotspot/service-port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/hotspot/service-port/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/hotspot/service-port/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/service-port/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/hotspot/service-port/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/service-port/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/hotspot/service-port/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/service-port/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/hotspot/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/setup post

POST: /ip/hotspot/setup (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/setup post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/setup" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/user get

GET: /ip/hotspot/user (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/user get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/user" \
	--user username:password

RESPONSE BODY

Type

array

/user put

PUT: /ip/hotspot/user (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/user put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/hotspot/user" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/hotspot/user/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/hotspot/user/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/hotspot/user/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/hotspot/user/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/hotspot/user/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/hotspot/user/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/hotspot/user/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/hotspot/user/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/hotspot/user/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/user/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/hotspot/user/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/hotspot/user/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/hotspot/user/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/hotspot/user/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/hotspot/user/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/profile get

GET: /ip/hotspot/user/profile (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/profile get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/user/profile" \
	--user username:password

RESPONSE BODY

Type

array

/profile put

PUT: /ip/hotspot/user/profile (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/profile put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/hotspot/user/profile" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/hotspot/user/profile/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/profile/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/hotspot/user/profile/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/profile/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/hotspot/user/profile/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/profile/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/hotspot/user/profile/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/profile/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/hotspot/user/profile/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/profile/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/hotspot/user/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/user/profile/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/hotspot/user/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/hotspot/user/profile/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/hotspot/user/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/hotspot/user/profile/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/hotspot/user/profile/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/profile/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/hotspot/user/profile/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/profile/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/hotspot/user/profile/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/profile/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/hotspot/user/profile/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/profile/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/hotspot/user/profile/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/profile/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/hotspot/user/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/hotspot/user/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ip/hotspot/user/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/hotspot/user/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/user/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/walled-garden get

GET: /ip/hotspot/walled-garden (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/walled-garden get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/walled-garden" \
	--user username:password

RESPONSE BODY

Type

array

/walled-garden put

PUT: /ip/hotspot/walled-garden (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/walled-garden put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/hotspot/walled-garden" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/hotspot/walled-garden/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/hotspot/walled-garden/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/hotspot/walled-garden/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/hotspot/walled-garden/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/hotspot/walled-garden/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/hotspot/walled-garden/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/hotspot/walled-garden/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/hotspot/walled-garden/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/hotspot/walled-garden/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/walled-garden/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/hotspot/walled-garden/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/hotspot/walled-garden/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/hotspot/walled-garden/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/hotspot/walled-garden/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ip get

GET: /ip/hotspot/walled-garden/ip (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ip get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip" \
	--user username:password

RESPONSE BODY

Type

array

/ip put

PUT: /ip/hotspot/walled-garden/ip (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ip put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/hotspot/walled-garden/ip/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/hotspot/walled-garden/ip/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/hotspot/walled-garden/ip/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/hotspot/walled-garden/ip/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/hotspot/walled-garden/ip/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/hotspot/walled-garden/ip/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/hotspot/walled-garden/ip/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/hotspot/walled-garden/ip/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/hotspot/walled-garden/ip/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/hotspot/walled-garden/ip/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/hotspot/walled-garden/ip/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/hotspot/walled-garden/ip/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/hotspot/walled-garden/ip/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/hotspot/walled-garden/ip/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/hotspot/walled-garden/ip/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/hotspot/walled-garden/ip/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/hotspot/walled-garden/ip/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/ip/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/hotspot/walled-garden/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/hotspot/walled-garden/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/hotspot/walled-garden/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/hotspot/walled-garden/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ip/hotspot/walled-garden/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /ip/hotspot/walled-garden/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/hotspot/walled-garden/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/hotspot/walled-garden/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/hotspot/walled-garden/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/active-peers get

GET: /ip/ipsec/active-peers (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/active-peers get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/active-peers" \
	--user username:password

RESPONSE BODY

Type

array

/active-peers put

PUT: /ip/ipsec/active-peers (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/active-peers put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/ipsec/active-peers" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/ipsec/active-peers/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/active-peers/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/ipsec/active-peers/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/active-peers/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/ipsec/active-peers/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/active-peers/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/ipsec/active-peers/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/active-peers/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/ipsec/active-peers/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/active-peers/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/ipsec/active-peers/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/active-peers/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/ipsec/active-peers/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/ipsec/active-peers/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/ipsec/active-peers/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/ipsec/active-peers/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/kill-connections post

POST: /ip/ipsec/active-peers/kill-connections (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/kill-connections post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/active-peers/kill-connections" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/ipsec/active-peers/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/active-peers/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/ipsec/active-peers/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/active-peers/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/ipsec/active-peers/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/active-peers/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/ipsec/active-peers/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/active-peers/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/ipsec/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/identity get

GET: /ip/ipsec/identity (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/identity get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/identity" \
	--user username:password

RESPONSE BODY

Type

array

/identity put

PUT: /ip/ipsec/identity (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/identity put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/ipsec/identity" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/ipsec/identity/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/identity/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/ipsec/identity/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/identity/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/ipsec/identity/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/identity/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/ipsec/identity/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/identity/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/ipsec/identity/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/identity/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/ipsec/identity/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/identity/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/ipsec/identity/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/identity/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/ipsec/identity/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/identity/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/ipsec/identity/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/identity/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/ipsec/identity/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/ipsec/identity/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/ipsec/identity/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/ipsec/identity/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/ipsec/identity/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/identity/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/ipsec/identity/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/identity/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/ipsec/identity/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/identity/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/ipsec/identity/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/identity/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/installed-sa get

GET: /ip/ipsec/installed-sa (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/installed-sa get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/installed-sa" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/ipsec/installed-sa/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/installed-sa/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/ipsec/installed-sa/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/installed-sa/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/flush post

POST: /ip/ipsec/installed-sa/flush (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/flush post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/installed-sa/flush" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/ipsec/installed-sa/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/installed-sa/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/ipsec/installed-sa/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/installed-sa/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /ip/ipsec/installed-sa/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/installed-sa/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/ipsec/installed-sa/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/installed-sa/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/key get

GET: /ip/ipsec/key (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/key get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/key" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/ipsec/key/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/key/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export-pub-key post

POST: /ip/ipsec/key/export-pub-key (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export-pub-key post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/key/export-pub-key" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/ipsec/key/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/key/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/generate-key post

POST: /ip/ipsec/key/generate-key (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/generate-key post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/key/generate-key" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/ipsec/key/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/key/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/ipsec/key/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/key/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/ipsec/key/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/ipsec/key/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/ipsec/key/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/ipsec/key/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/import post

POST: /ip/ipsec/key/import (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/import post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/key/import" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/ipsec/key/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/key/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/ipsec/key/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/key/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/ipsec/key/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/key/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/ipsec/key/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/key/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/mode-config get

GET: /ip/ipsec/mode-config (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mode-config get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/mode-config" \
	--user username:password

RESPONSE BODY

Type

array

/mode-config put

PUT: /ip/ipsec/mode-config (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mode-config put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/ipsec/mode-config" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/ipsec/mode-config/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/mode-config/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/ipsec/mode-config/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/mode-config/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/ipsec/mode-config/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/mode-config/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/ipsec/mode-config/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/mode-config/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/ipsec/mode-config/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/mode-config/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/ipsec/mode-config/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/mode-config/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/ipsec/mode-config/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/mode-config/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/ipsec/mode-config/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/mode-config/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/ipsec/mode-config/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/ipsec/mode-config/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/ipsec/mode-config/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/ipsec/mode-config/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/ipsec/mode-config/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/mode-config/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/ipsec/mode-config/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/mode-config/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/ipsec/mode-config/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/mode-config/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/ipsec/mode-config/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/mode-config/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/peer get

GET: /ip/ipsec/peer (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/peer get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/peer" \
	--user username:password

RESPONSE BODY

Type

array

/peer put

PUT: /ip/ipsec/peer (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/peer put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/ipsec/peer" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/ipsec/peer/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/peer/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/ipsec/peer/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/peer/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/ipsec/peer/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/peer/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/ipsec/peer/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/peer/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/ipsec/peer/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/peer/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/ipsec/peer/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/peer/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/ipsec/peer/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/peer/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/ipsec/peer/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/peer/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/ipsec/peer/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/peer/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/ipsec/peer/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/ipsec/peer/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/ipsec/peer/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/ipsec/peer/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/ipsec/peer/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/peer/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/ipsec/peer/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/peer/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/ipsec/peer/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/peer/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/ipsec/peer/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/peer/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/policy get

GET: /ip/ipsec/policy (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/policy get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/policy" \
	--user username:password

RESPONSE BODY

Type

array

/policy put

PUT: /ip/ipsec/policy (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/policy put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/ipsec/policy" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/ipsec/policy/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/ipsec/policy/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/ipsec/policy/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/ipsec/policy/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/ipsec/policy/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/ipsec/policy/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/ipsec/policy/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/ipsec/policy/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/ipsec/policy/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/policy/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/ipsec/policy/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/ipsec/policy/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/ipsec/policy/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/ipsec/policy/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/group get

GET: /ip/ipsec/policy/group (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/group get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/policy/group" \
	--user username:password

RESPONSE BODY

Type

array

/group put

PUT: /ip/ipsec/policy/group (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/group put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/ipsec/policy/group" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/ipsec/policy/group/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/group/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/ipsec/policy/group/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/group/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/ipsec/policy/group/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/group/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/ipsec/policy/group/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/group/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/ipsec/policy/group/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/group/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/ipsec/policy/group/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/group/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/ipsec/policy/group/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/policy/group/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/ipsec/policy/group/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/ipsec/policy/group/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/ipsec/policy/group/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/ipsec/policy/group/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/ipsec/policy/group/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/group/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/ipsec/policy/group/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/group/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/ipsec/policy/group/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/group/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/ipsec/policy/group/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/group/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/ipsec/policy/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/ipsec/policy/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/ipsec/policy/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/ipsec/policy/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/ipsec/policy/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/policy/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/profile get

GET: /ip/ipsec/profile (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/profile get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/profile" \
	--user username:password

RESPONSE BODY

Type

array

/profile put

PUT: /ip/ipsec/profile (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/profile put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/ipsec/profile" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/ipsec/profile/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/profile/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/ipsec/profile/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/profile/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/ipsec/profile/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/profile/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/ipsec/profile/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/profile/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/ipsec/profile/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/profile/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/ipsec/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/profile/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/ipsec/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/ipsec/profile/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/ipsec/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/ipsec/profile/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/ipsec/profile/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/profile/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/ipsec/profile/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/profile/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/ipsec/profile/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/profile/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/ipsec/profile/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/profile/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/proposal get

GET: /ip/ipsec/proposal (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/proposal get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/proposal" \
	--user username:password

RESPONSE BODY

Type

array

/proposal put

PUT: /ip/ipsec/proposal (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/proposal put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/ipsec/proposal" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/ipsec/proposal/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/proposal/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/ipsec/proposal/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/proposal/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/ipsec/proposal/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/proposal/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/ipsec/proposal/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/proposal/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/ipsec/proposal/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/proposal/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/ipsec/proposal/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/proposal/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/ipsec/proposal/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/proposal/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/ipsec/proposal/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/proposal/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/ipsec/proposal/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/proposal/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/ipsec/proposal/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/ipsec/proposal/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/ipsec/proposal/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/ipsec/proposal/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/ipsec/proposal/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/proposal/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/ipsec/proposal/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/proposal/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/ipsec/proposal/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/proposal/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/ipsec/proposal/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/proposal/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /ip/ipsec/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/ipsec/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/ipsec/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/ipsec/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/ipsec/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/ipsec/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/ipsec/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/ipsec/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/ipsec/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/statistics get

GET: /ip/ipsec/statistics (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/statistics get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/statistics" \
	--user username:password

RESPONSE BODY

Type

array

/get post

POST: /ip/ipsec/statistics/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/statistics/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/ipsec/statistics/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ipsec/statistics/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /ip/ipsec/statistics/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ipsec/statistics/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/kid-control get

GET: /ip/kid-control (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/kid-control get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/kid-control" \
	--user username:password

RESPONSE BODY

Type

array

/kid-control put

PUT: /ip/kid-control (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/kid-control put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/kid-control" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/kid-control/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/device get

GET: /ip/kid-control/device (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/device get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/kid-control/device" \
	--user username:password

RESPONSE BODY

Type

array

/device put

PUT: /ip/kid-control/device (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/device put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/kid-control/device" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/kid-control/device/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/device/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/kid-control/device/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/device/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/kid-control/device/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/device/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/kid-control/device/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/device/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/kid-control/device/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/device/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/kid-control/device/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/device/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/kid-control/device/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/device/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/kid-control/device/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/kid-control/device/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/kid-control/device/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/kid-control/device/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/kid-control/device/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/kid-control/device/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/kid-control/device/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/device/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/kid-control/device/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/device/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/kid-control/device/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/device/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ip/kid-control/device/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/device/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/kid-control/device/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/device/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/kid-control/device/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/device/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/kid-control/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/kid-control/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/kid-control/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/kid-control/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/kid-control/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/kid-control/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/kid-control/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/kid-control/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/kid-control/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/kid-control/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/kid-control/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/kid-control/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/pause post

POST: /ip/kid-control/pause (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pause post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/pause" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/kid-control/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/kid-control/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/kid-control/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/resume post

POST: /ip/kid-control/resume (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/resume post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/resume" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/kid-control/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/kid-control/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/media get

GET: /ip/media (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/media get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/media" \
	--user username:password

RESPONSE BODY

Type

array

/media put

PUT: /ip/media (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/media put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/media" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/media/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/media/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/media/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/media/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/media/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/media/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/media/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/media/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/media/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/media/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/media/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/media/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/media/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/media/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/media/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/media/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/media/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /ip/media/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/media/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/media/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/media/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/media/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/media/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/media/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/media/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/media/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/media/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/media/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/media/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/nat-pmp get

GET: /ip/nat-pmp (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/nat-pmp get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/nat-pmp" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/nat-pmp/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/nat-pmp/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/nat-pmp/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/nat-pmp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/nat-pmp/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/nat-pmp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/nat-pmp/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interfaces get

GET: /ip/nat-pmp/interfaces (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interfaces get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/nat-pmp/interfaces" \
	--user username:password

RESPONSE BODY

Type

array

/interfaces put

PUT: /ip/nat-pmp/interfaces (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interfaces put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/nat-pmp/interfaces" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/nat-pmp/interfaces/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/interfaces/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/nat-pmp/interfaces/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/interfaces/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/nat-pmp/interfaces/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/interfaces/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/nat-pmp/interfaces/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/interfaces/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/nat-pmp/interfaces/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/interfaces/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/nat-pmp/interfaces/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/interfaces/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/nat-pmp/interfaces/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/interfaces/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/nat-pmp/interfaces/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/nat-pmp/interfaces/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/nat-pmp/interfaces/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/nat-pmp/interfaces/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/nat-pmp/interfaces/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/nat-pmp/interfaces/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/nat-pmp/interfaces/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/interfaces/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/nat-pmp/interfaces/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/interfaces/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/nat-pmp/interfaces/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/interfaces/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/nat-pmp/interfaces/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/interfaces/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/nat-pmp/interfaces/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/interfaces/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/nat-pmp/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/nat-pmp/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/nat-pmp/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/neighbor get

GET: /ip/neighbor (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/neighbor get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/neighbor" \
	--user username:password

RESPONSE BODY

Type

array

/discovery-settings get

GET: /ip/neighbor/discovery-settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/discovery-settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/neighbor/discovery-settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/neighbor/discovery-settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/neighbor/discovery-settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/neighbor/discovery-settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/neighbor/discovery-settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/neighbor/discovery-settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/neighbor/discovery-settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/neighbor/discovery-settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/neighbor/discovery-settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/neighbor/discovery-settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/neighbor/discovery-settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/neighbor/discovery-settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/neighbor/discovery-settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/neighbor/discovery-settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/neighbor/discovery-settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/neighbor/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/neighbor/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/neighbor/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/neighbor/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/neighbor/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/neighbor/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/neighbor/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /ip/neighbor/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/neighbor/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/packing get

GET: /ip/packing (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/packing get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/packing" \
	--user username:password

RESPONSE BODY

Type

array

/packing put

PUT: /ip/packing (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/packing put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/packing" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/packing/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/packing/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/packing/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/packing/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/packing/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/packing/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/packing/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/packing/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/packing/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/packing/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/packing/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/packing/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/packing/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/packing/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/packing/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/packing/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/packing/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/packing/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/packing/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/packing/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/packing/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/packing/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/packing/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/packing/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/packing/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/packing/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/packing/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/packing/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/pool get

GET: /ip/pool (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pool get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/pool" \
	--user username:password

RESPONSE BODY

Type

array

/pool put

PUT: /ip/pool (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pool put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/pool" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/pool/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/pool/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/pool/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/pool/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/pool/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/pool/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/pool/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/pool/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/pool/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/pool/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/pool/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/pool/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/pool/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/pool/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/pool/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/pool/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/used get

GET: /ip/pool/used (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/used get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/pool/used" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/pool/used/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/used/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/pool/used/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/used/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/pool/used/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/used/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/pool/used/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/pool/used/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/pool/used/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/pool/used/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/pool/used/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/used/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/pool/used/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/used/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/pool/used/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/pool/used/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/proxy get

GET: /ip/proxy (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/proxy get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy" \
	--user username:password

RESPONSE BODY

Type

array

/access get

GET: /ip/proxy/access (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/access get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/access" \
	--user username:password

RESPONSE BODY

Type

array

/access put

PUT: /ip/proxy/access (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/access put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/proxy/access" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/proxy/access/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/proxy/access/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/proxy/access/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/proxy/access/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/proxy/access/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/proxy/access/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/proxy/access/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/proxy/access/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/proxy/access/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/access/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/proxy/access/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/proxy/access/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/proxy/access/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/proxy/access/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/proxy/access/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/proxy/access/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/proxy/access/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/proxy/access/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ip/proxy/access/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /ip/proxy/access/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/proxy/access/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/proxy/access/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/access/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/cache get

GET: /ip/proxy/cache (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/cache get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/cache" \
	--user username:password

RESPONSE BODY

Type

array

/cache put

PUT: /ip/proxy/cache (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/cache put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/proxy/cache" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/proxy/cache/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/proxy/cache/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/proxy/cache/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/proxy/cache/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/proxy/cache/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/proxy/cache/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/proxy/cache/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/proxy/cache/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/proxy/cache/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/cache/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/proxy/cache/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/proxy/cache/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/proxy/cache/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/proxy/cache/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/proxy/cache/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/proxy/cache/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/proxy/cache/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/proxy/cache/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ip/proxy/cache/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /ip/proxy/cache/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/proxy/cache/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/proxy/cache/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/cache-contents get

GET: /ip/proxy/cache-contents (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/cache-contents get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/cache-contents" \
	--user username:password

RESPONSE BODY

Type

array

/cache-contents put

PUT: /ip/proxy/cache-contents (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/cache-contents put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/proxy/cache-contents" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/proxy/cache-contents/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache-contents/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/proxy/cache-contents/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache-contents/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/proxy/cache-contents/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache-contents/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/proxy/cache-contents/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/cache-contents/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/proxy/cache-contents/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/proxy/cache-contents/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/proxy/cache-contents/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache-contents/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/proxy/cache-contents/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/cache-contents/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/clear-cache post

POST: /ip/proxy/clear-cache (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/clear-cache post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/clear-cache" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/connections get

GET: /ip/proxy/connections (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/connections get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/connections" \
	--user username:password

RESPONSE BODY

Type

array

/comment post

POST: /ip/proxy/connections/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/connections/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/proxy/connections/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/connections/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/proxy/connections/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/connections/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/proxy/connections/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/connections/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/proxy/connections/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/connections/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/proxy/connections/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/proxy/connections/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/proxy/connections/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/proxy/connections/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/proxy/connections/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/connections/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/proxy/connections/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/connections/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/proxy/connections/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/connections/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/proxy/connections/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/connections/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/direct get

GET: /ip/proxy/direct (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/direct get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/direct" \
	--user username:password

RESPONSE BODY

Type

array

/direct put

PUT: /ip/proxy/direct (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/direct put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/proxy/direct" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/proxy/direct/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/proxy/direct/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/proxy/direct/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/proxy/direct/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/proxy/direct/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/proxy/direct/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/proxy/direct/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/proxy/direct/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/proxy/direct/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/direct/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/proxy/direct/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/proxy/direct/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/proxy/direct/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/proxy/direct/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/proxy/direct/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/proxy/direct/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/proxy/direct/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/proxy/direct/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ip/proxy/direct/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /ip/proxy/direct/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/proxy/direct/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/proxy/direct/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/direct/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/proxy/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/proxy/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/proxy/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/proxy/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/proxy/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/proxy/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/inserts get

GET: /ip/proxy/inserts (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/inserts get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/inserts" \
	--user username:password

RESPONSE BODY

Type

array

/get post

POST: /ip/proxy/inserts/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/inserts/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/proxy/inserts/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/inserts/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /ip/proxy/inserts/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/inserts/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/lookups get

GET: /ip/proxy/lookups (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/lookups get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/lookups" \
	--user username:password

RESPONSE BODY

Type

array

/get post

POST: /ip/proxy/lookups/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/lookups/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/proxy/lookups/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/lookups/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /ip/proxy/lookups/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/lookups/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /ip/proxy/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/proxy/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/refreshes get

GET: /ip/proxy/refreshes (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/refreshes get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/refreshes" \
	--user username:password

RESPONSE BODY

Type

array

/get post

POST: /ip/proxy/refreshes/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/refreshes/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/proxy/refreshes/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/proxy/refreshes/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /ip/proxy/refreshes/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/refreshes/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-html post

POST: /ip/proxy/reset-html (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-html post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/reset-html" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/proxy/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/proxy/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/route get

GET: /ip/route (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/route get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/route" \
	--user username:password

RESPONSE BODY

Type

array

/route put

PUT: /ip/route (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/route put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/route" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/route/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/route/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/route/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/route/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/route/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/route/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/route/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/route/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/route/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/route/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/route/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/route/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/route/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/route/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/route/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/route/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/route/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/route/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/route/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/route/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/route/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/route/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/route/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/route/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/route/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/route/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/route/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/route/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/route/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/route/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/route/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/route/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/service get

GET: /ip/service (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/service get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/service" \
	--user username:password

RESPONSE BODY

Type

array

/disable post

POST: /ip/service/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/service/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/service/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/service/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/service/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/service/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/service/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/service/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/service/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/service/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/service/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/service/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/service/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/service/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/service/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/service/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/service/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/service/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/service/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/service/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/service/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/service/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/service/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/service/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /ip/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/smb get

GET: /ip/smb (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/smb get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/smb" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/smb/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/smb/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/smb/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/smb/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/smb/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/smb/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/smb/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/smb/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/smb/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/shares get

GET: /ip/smb/shares (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/shares get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/smb/shares" \
	--user username:password

RESPONSE BODY

Type

array

/shares put

PUT: /ip/smb/shares (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/shares put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/smb/shares" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/smb/shares/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/shares/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/smb/shares/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/shares/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/smb/shares/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/shares/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/smb/shares/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/shares/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/smb/shares/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/shares/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/smb/shares/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/shares/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/smb/shares/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/shares/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/smb/shares/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/shares/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/smb/shares/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/smb/shares/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/smb/shares/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/smb/shares/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/smb/shares/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/smb/shares/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/smb/shares/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/shares/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/smb/shares/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/shares/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/smb/shares/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/shares/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/smb/shares/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/shares/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/users get

GET: /ip/smb/users (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/users get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/smb/users" \
	--user username:password

RESPONSE BODY

Type

array

/users put

PUT: /ip/smb/users (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/users put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/smb/users" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/smb/users/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/users/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/smb/users/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/users/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/smb/users/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/users/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/smb/users/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/users/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/smb/users/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/users/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/smb/users/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/users/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/smb/users/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/users/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/smb/users/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/users/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/smb/users/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/smb/users/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/smb/users/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/smb/users/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/smb/users/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/smb/users/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/smb/users/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/users/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/smb/users/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/users/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/smb/users/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/users/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/smb/users/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/smb/users/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/socks get

GET: /ip/socks (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/socks get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/socks" \
	--user username:password

RESPONSE BODY

Type

array

/access get

GET: /ip/socks/access (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/access get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/socks/access" \
	--user username:password

RESPONSE BODY

Type

array

/access put

PUT: /ip/socks/access (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/access put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/socks/access" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/socks/access/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/access/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/socks/access/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/access/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/socks/access/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/access/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/socks/access/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/access/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/socks/access/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/access/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/socks/access/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/access/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/socks/access/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/access/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/socks/access/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/access/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/socks/access/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/socks/access/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/socks/access/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/socks/access/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/socks/access/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/socks/access/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/socks/access/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/access/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/socks/access/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/access/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/socks/access/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/access/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/socks/access/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/access/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/socks/access/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/access/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/socks/access/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/access/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/connections get

GET: /ip/socks/connections (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/connections get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/socks/connections" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/socks/connections/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/connections/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/socks/connections/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/connections/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/socks/connections/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/connections/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/socks/connections/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/socks/connections/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/socks/connections/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/socks/connections/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/socks/connections/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/socks/connections/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/socks/connections/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/connections/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/socks/connections/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/connections/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/socks/connections/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/connections/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/socks/connections/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/connections/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/socks/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/socks/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/socks/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/socks/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/socks/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/socks/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/socks/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/socks/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/socks/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/users get

GET: /ip/socks/users (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/users get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/socks/users" \
	--user username:password

RESPONSE BODY

Type

array

/users put

PUT: /ip/socks/users (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/users put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/socks/users" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/socks/users/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/users/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/socks/users/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/users/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/socks/users/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/users/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/socks/users/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/users/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/socks/users/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/users/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/socks/users/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/users/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/socks/users/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/users/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/socks/users/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/socks/users/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/socks/users/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/socks/users/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/socks/users/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/socks/users/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/socks/users/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/users/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/socks/users/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/users/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/socks/users/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/users/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/socks/users/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/socks/users/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ssh get

GET: /ip/ssh (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ssh get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ssh" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/ssh/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ssh/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/ssh/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ssh/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export-host-key post

POST: /ip/ssh/export-host-key (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export-host-key post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ssh/export-host-key" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/ssh/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ssh/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/ssh/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/ssh/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/ssh/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/ssh/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/import-host-key post

POST: /ip/ssh/import-host-key (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/import-host-key post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ssh/import-host-key" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/ssh/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ssh/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/regenerate-host-key post

POST: /ip/ssh/regenerate-host-key (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/regenerate-host-key post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ssh/regenerate-host-key" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/ssh/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/ssh/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/tftp get

GET: /ip/tftp (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/tftp get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/tftp" \
	--user username:password

RESPONSE BODY

Type

array

/tftp put

PUT: /ip/tftp (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/tftp put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/tftp" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/tftp/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/tftp/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/tftp/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/tftp/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/tftp/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/tftp/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/tftp/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/tftp/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/tftp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/tftp/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/tftp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/tftp/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/tftp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/tftp/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/tftp/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/tftp/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/tftp/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/tftp/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/tftp/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /ip/tftp/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/tftp/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/tftp/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/tftp/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/tftp/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/tftp/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/tftp/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/tftp/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/tftp/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/tftp/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/tftp/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/tftp/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/traffic-flow get

GET: /ip/traffic-flow (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/traffic-flow get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/traffic-flow" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/traffic-flow/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/traffic-flow/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/traffic-flow/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/traffic-flow/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/traffic-flow/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/traffic-flow/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/traffic-flow/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ipfix get

GET: /ip/traffic-flow/ipfix (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ipfix get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/traffic-flow/ipfix" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/traffic-flow/ipfix/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/ipfix/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/traffic-flow/ipfix/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/ipfix/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/traffic-flow/ipfix/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/ipfix/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/traffic-flow/ipfix/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/traffic-flow/ipfix/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/traffic-flow/ipfix/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/traffic-flow/ipfix/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/traffic-flow/ipfix/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/ipfix/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/traffic-flow/ipfix/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/ipfix/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /ip/traffic-flow/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/traffic-flow/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/traffic-flow/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/target get

GET: /ip/traffic-flow/target (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/target get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/traffic-flow/target" \
	--user username:password

RESPONSE BODY

Type

array

/target put

PUT: /ip/traffic-flow/target (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/target put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/traffic-flow/target" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/traffic-flow/target/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/target/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/traffic-flow/target/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/target/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/traffic-flow/target/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/target/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/traffic-flow/target/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/target/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/traffic-flow/target/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/target/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/traffic-flow/target/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/target/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/traffic-flow/target/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/target/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/traffic-flow/target/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/traffic-flow/target/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/traffic-flow/target/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/traffic-flow/target/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/traffic-flow/target/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/traffic-flow/target/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/traffic-flow/target/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/target/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/traffic-flow/target/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/target/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/traffic-flow/target/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/target/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/traffic-flow/target/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/traffic-flow/target/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/upnp get

GET: /ip/upnp (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/upnp get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/upnp" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ip/upnp/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/upnp/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/upnp/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/upnp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/upnp/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/upnp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/upnp/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interfaces get

GET: /ip/upnp/interfaces (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interfaces get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/upnp/interfaces" \
	--user username:password

RESPONSE BODY

Type

array

/interfaces put

PUT: /ip/upnp/interfaces (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interfaces put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/upnp/interfaces" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/upnp/interfaces/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/interfaces/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/upnp/interfaces/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/interfaces/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/upnp/interfaces/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/interfaces/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/upnp/interfaces/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/interfaces/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/upnp/interfaces/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/interfaces/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/upnp/interfaces/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/interfaces/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/upnp/interfaces/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/interfaces/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/upnp/interfaces/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/upnp/interfaces/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/upnp/interfaces/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/upnp/interfaces/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/upnp/interfaces/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/upnp/interfaces/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/upnp/interfaces/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/interfaces/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/upnp/interfaces/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/interfaces/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/upnp/interfaces/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/interfaces/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/upnp/interfaces/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/interfaces/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ip/upnp/interfaces/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/interfaces/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/upnp/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/upnp/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/upnp/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/vrf get

GET: /ip/vrf (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vrf get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/vrf" \
	--user username:password

RESPONSE BODY

Type

array

/vrf put

PUT: /ip/vrf (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vrf put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ip/vrf" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ip/vrf/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/vrf/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ip/vrf/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/vrf/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ip/vrf/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/vrf/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ip/vrf/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/vrf/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ip/vrf/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/vrf/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/vrf/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/vrf/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ip/vrf/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/vrf/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ip/vrf/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/vrf/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ip/vrf/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ip/vrf/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ip/vrf/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ip/vrf/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ip/vrf/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ip/vrf/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ip/vrf/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/vrf/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ip/vrf/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/vrf/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ip/vrf/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/vrf/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ip/vrf/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/vrf/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ip/vrf/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/vrf/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ip/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ip/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ipv6

/address get

GET: /ipv6/address (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/address get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/address" \
	--user username:password

RESPONSE BODY

Type

array

/address put

PUT: /ipv6/address (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/address put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/address" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/address/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/address/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ipv6/address/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/address/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ipv6/address/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/address/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/address/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/address/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ipv6/address/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/address/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/address/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/address/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/address/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/address/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/address/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/address/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/address/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/address/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/address/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/address/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/address/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/address/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/address/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/address/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/address/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/address/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/address/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/address/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/address/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/address/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/dhcp-client get

GET: /ipv6/dhcp-client (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dhcp-client get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/dhcp-client" \
	--user username:password

RESPONSE BODY

Type

array

/dhcp-client put

PUT: /ipv6/dhcp-client (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dhcp-client put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/dhcp-client" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/dhcp-client/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ipv6/dhcp-client/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ipv6/dhcp-client/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/dhcp-client/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ipv6/dhcp-client/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/dhcp-client/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/dhcp-client/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/dhcp-client/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/dhcp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/dhcp-client/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/dhcp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/dhcp-client/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/dhcp-client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/dhcp-client/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/option get

GET: /ipv6/dhcp-client/option (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/option get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/dhcp-client/option" \
	--user username:password

RESPONSE BODY

Type

array

/option put

PUT: /ipv6/dhcp-client/option (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/option put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/dhcp-client/option" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/dhcp-client/option/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/option/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/dhcp-client/option/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/option/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/dhcp-client/option/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/option/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/dhcp-client/option/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/option/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/dhcp-client/option/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/option/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/dhcp-client/option/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/dhcp-client/option/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/dhcp-client/option/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/dhcp-client/option/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/dhcp-client/option/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/dhcp-client/option/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/dhcp-client/option/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/option/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/dhcp-client/option/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/option/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/dhcp-client/option/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/option/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/dhcp-client/option/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/option/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/dhcp-client/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/release post

POST: /ipv6/dhcp-client/release (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/release post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/release" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/dhcp-client/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/renew post

POST: /ipv6/dhcp-client/renew (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/renew post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/renew" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/dhcp-client/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/dhcp-client/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-client/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/dhcp-relay get

GET: /ipv6/dhcp-relay (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dhcp-relay get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/dhcp-relay" \
	--user username:password

RESPONSE BODY

Type

array

/dhcp-relay put

PUT: /ipv6/dhcp-relay (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dhcp-relay put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/dhcp-relay" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/dhcp-relay/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-relay/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ipv6/dhcp-relay/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-relay/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ipv6/dhcp-relay/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-relay/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/dhcp-relay/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-relay/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ipv6/dhcp-relay/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-relay/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/dhcp-relay/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-relay/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/dhcp-relay/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-relay/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/dhcp-relay/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-relay/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/dhcp-relay/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/dhcp-relay/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/dhcp-relay/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/dhcp-relay/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/dhcp-relay/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/dhcp-relay/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /ipv6/dhcp-relay/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-relay/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/dhcp-relay/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-relay/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/dhcp-relay/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-relay/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/dhcp-relay/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-relay/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ipv6/dhcp-relay/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-relay/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/dhcp-relay/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-relay/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/dhcp-server get

GET: /ipv6/dhcp-server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dhcp-server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/dhcp-server" \
	--user username:password

RESPONSE BODY

Type

array

/dhcp-server put

PUT: /ipv6/dhcp-server (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dhcp-server put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/dhcp-server" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/dhcp-server/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/binding get

GET: /ipv6/dhcp-server/binding (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/binding get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/dhcp-server/binding" \
	--user username:password

RESPONSE BODY

Type

array

/binding put

PUT: /ipv6/dhcp-server/binding (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/binding put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/dhcp-server/binding" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/dhcp-server/binding/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/binding/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ipv6/dhcp-server/binding/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/binding/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ipv6/dhcp-server/binding/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/binding/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/dhcp-server/binding/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/binding/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ipv6/dhcp-server/binding/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/binding/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/dhcp-server/binding/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/binding/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/dhcp-server/binding/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/binding/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/dhcp-server/binding/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/binding/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/dhcp-server/binding/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/dhcp-server/binding/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/dhcp-server/binding/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/dhcp-server/binding/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/dhcp-server/binding/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/dhcp-server/binding/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/make-static post

POST: /ipv6/dhcp-server/binding/make-static (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/make-static post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/binding/make-static" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/dhcp-server/binding/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/binding/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/dhcp-server/binding/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/binding/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/dhcp-server/binding/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/binding/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/dhcp-server/binding/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/binding/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ipv6/dhcp-server/binding/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/binding/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ipv6/dhcp-server/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ipv6/dhcp-server/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/dhcp-server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ipv6/dhcp-server/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/dhcp-server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/dhcp-server/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/dhcp-server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/dhcp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/dhcp-server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/dhcp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/dhcp-server/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/dhcp-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/dhcp-server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/option get

GET: /ipv6/dhcp-server/option (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/option get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/dhcp-server/option" \
	--user username:password

RESPONSE BODY

Type

array

/option put

PUT: /ipv6/dhcp-server/option (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/option put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/dhcp-server/option" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/dhcp-server/option/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/dhcp-server/option/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/dhcp-server/option/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/dhcp-server/option/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/dhcp-server/option/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/dhcp-server/option/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/dhcp-server/option/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/dhcp-server/option/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/dhcp-server/option/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/dhcp-server/option/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/dhcp-server/option/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/dhcp-server/option/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/dhcp-server/option/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/dhcp-server/option/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/dhcp-server/option/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/sets get

GET: /ipv6/dhcp-server/option/sets (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sets get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/dhcp-server/option/sets" \
	--user username:password

RESPONSE BODY

Type

array

/sets put

PUT: /ipv6/dhcp-server/option/sets (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sets put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/dhcp-server/option/sets" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/dhcp-server/option/sets/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/sets/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/dhcp-server/option/sets/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/sets/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/dhcp-server/option/sets/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/sets/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/dhcp-server/option/sets/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/sets/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/dhcp-server/option/sets/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/sets/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/dhcp-server/option/sets/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/dhcp-server/option/sets/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/dhcp-server/option/sets/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/dhcp-server/option/sets/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/dhcp-server/option/sets/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/dhcp-server/option/sets/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/dhcp-server/option/sets/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/sets/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/dhcp-server/option/sets/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/sets/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/dhcp-server/option/sets/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/sets/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/dhcp-server/option/sets/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/option/sets/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/dhcp-server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/dhcp-server/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/dhcp-server/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/dhcp-server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/dhcp-server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/address-list get

GET: /ipv6/firewall/address-list (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/address-list get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/firewall/address-list" \
	--user username:password

RESPONSE BODY

Type

array

/address-list put

PUT: /ipv6/firewall/address-list (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/address-list put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/firewall/address-list" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/firewall/address-list/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/address-list/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ipv6/firewall/address-list/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/address-list/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ipv6/firewall/address-list/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/address-list/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/firewall/address-list/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/address-list/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ipv6/firewall/address-list/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/address-list/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/firewall/address-list/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/address-list/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/firewall/address-list/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/address-list/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/firewall/address-list/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/address-list/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/firewall/address-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/firewall/address-list/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/firewall/address-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/firewall/address-list/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/firewall/address-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/firewall/address-list/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/firewall/address-list/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/address-list/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/firewall/address-list/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/address-list/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/firewall/address-list/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/address-list/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/firewall/address-list/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/address-list/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/connection get

GET: /ipv6/firewall/connection (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/connection get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/firewall/connection" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /ipv6/firewall/connection/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/connection/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/firewall/connection/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/connection/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/firewall/connection/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/firewall/connection/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/firewall/connection/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/firewall/connection/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/firewall/connection/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/connection/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/firewall/connection/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/connection/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/firewall/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/filter get

GET: /ipv6/firewall/filter (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/filter get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/firewall/filter" \
	--user username:password

RESPONSE BODY

Type

array

/filter put

PUT: /ipv6/firewall/filter (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/filter put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/firewall/filter" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/firewall/filter/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ipv6/firewall/filter/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ipv6/firewall/filter/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/firewall/filter/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ipv6/firewall/filter/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/firewall/filter/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/firewall/filter/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/firewall/filter/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/firewall/filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/firewall/filter/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/firewall/filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/firewall/filter/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/firewall/filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/firewall/filter/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ipv6/firewall/filter/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/firewall/filter/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/firewall/filter/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/firewall/filter/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ipv6/firewall/filter/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /ipv6/firewall/filter/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/firewall/filter/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ipv6/firewall/filter/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/filter/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/mangle get

GET: /ipv6/firewall/mangle (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mangle get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/firewall/mangle" \
	--user username:password

RESPONSE BODY

Type

array

/mangle put

PUT: /ipv6/firewall/mangle (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mangle put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/firewall/mangle" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/firewall/mangle/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ipv6/firewall/mangle/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ipv6/firewall/mangle/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/firewall/mangle/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ipv6/firewall/mangle/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/firewall/mangle/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/firewall/mangle/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/firewall/mangle/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/firewall/mangle/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/firewall/mangle/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/firewall/mangle/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/firewall/mangle/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/firewall/mangle/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/firewall/mangle/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ipv6/firewall/mangle/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/firewall/mangle/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/firewall/mangle/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/firewall/mangle/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ipv6/firewall/mangle/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /ipv6/firewall/mangle/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/firewall/mangle/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ipv6/firewall/mangle/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/mangle/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/nat get

GET: /ipv6/firewall/nat (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/nat get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/firewall/nat" \
	--user username:password

RESPONSE BODY

Type

array

/nat put

PUT: /ipv6/firewall/nat (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/nat put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/firewall/nat" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/firewall/nat/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ipv6/firewall/nat/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ipv6/firewall/nat/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/firewall/nat/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ipv6/firewall/nat/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/firewall/nat/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/firewall/nat/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/firewall/nat/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/firewall/nat/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/firewall/nat/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/firewall/nat/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/firewall/nat/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/firewall/nat/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/firewall/nat/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ipv6/firewall/nat/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/firewall/nat/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/firewall/nat/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/firewall/nat/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ipv6/firewall/nat/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /ipv6/firewall/nat/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/firewall/nat/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ipv6/firewall/nat/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/nat/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/raw get

GET: /ipv6/firewall/raw (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/raw get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/firewall/raw" \
	--user username:password

RESPONSE BODY

Type

array

/raw put

PUT: /ipv6/firewall/raw (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/raw put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/firewall/raw" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/firewall/raw/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ipv6/firewall/raw/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ipv6/firewall/raw/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/firewall/raw/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ipv6/firewall/raw/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/firewall/raw/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/firewall/raw/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/firewall/raw/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/firewall/raw/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/firewall/raw/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/firewall/raw/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/firewall/raw/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/firewall/raw/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/firewall/raw/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /ipv6/firewall/raw/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/firewall/raw/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/firewall/raw/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/firewall/raw/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /ipv6/firewall/raw/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /ipv6/firewall/raw/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/firewall/raw/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ipv6/firewall/raw/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/firewall/raw/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/nd get

GET: /ipv6/nd (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/nd get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/nd" \
	--user username:password

RESPONSE BODY

Type

array

/nd put

PUT: /ipv6/nd (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/nd put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/nd" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/nd/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ipv6/nd/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ipv6/nd/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/nd/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ipv6/nd/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/nd/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/nd/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/nd/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/nd/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/nd/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/nd/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/nd/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/nd/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/nd/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/prefix get

GET: /ipv6/nd/prefix (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/prefix get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/nd/prefix" \
	--user username:password

RESPONSE BODY

Type

array

/prefix put

PUT: /ipv6/nd/prefix (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/prefix put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/nd/prefix" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/nd/prefix/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ipv6/nd/prefix/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/default get

GET: /ipv6/nd/prefix/default (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/default get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/nd/prefix/default" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ipv6/nd/prefix/default/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/default/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/nd/prefix/default/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/default/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/nd/prefix/default/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/default/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/nd/prefix/default/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/nd/prefix/default/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/nd/prefix/default/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/nd/prefix/default/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/nd/prefix/default/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/default/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/nd/prefix/default/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/default/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ipv6/nd/prefix/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/nd/prefix/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ipv6/nd/prefix/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/nd/prefix/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/nd/prefix/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/nd/prefix/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/nd/prefix/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/nd/prefix/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/nd/prefix/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/nd/prefix/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/nd/prefix/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/nd/prefix/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/nd/prefix/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/nd/prefix/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/nd/prefix/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/nd/prefix/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/prefix/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/nd/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/nd/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/nd/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/nd/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/nd/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/neighbor get

GET: /ipv6/neighbor (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/neighbor get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/neighbor" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /ipv6/neighbor/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/neighbor/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/neighbor/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/neighbor/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/neighbor/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /ipv6/neighbor/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/neighbor/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/pool get

GET: /ipv6/pool (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pool get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/pool" \
	--user username:password

RESPONSE BODY

Type

array

/pool put

PUT: /ipv6/pool (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pool put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/pool" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/pool/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/pool/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ipv6/pool/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/pool/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/pool/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/pool/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/pool/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/pool/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/pool/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/pool/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/pool/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/pool/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/pool/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/pool/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/pool/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/pool/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/pool/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/pool/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/pool/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/pool/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/pool/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/pool/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/pool/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/pool/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/pool/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/pool/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/used get

GET: /ipv6/pool/used (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/used get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/pool/used" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /ipv6/pool/used/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/pool/used/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/pool/used/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/pool/used/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/pool/used/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/pool/used/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /ipv6/pool/used/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/pool/used/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/route get

GET: /ipv6/route (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/route get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/route" \
	--user username:password

RESPONSE BODY

Type

array

/route put

PUT: /ipv6/route (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/route put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ipv6/route" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ipv6/route/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/route/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ipv6/route/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/route/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ipv6/route/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/route/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ipv6/route/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/route/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ipv6/route/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/route/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/route/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/route/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ipv6/route/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/route/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/route/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/route/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/route/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/route/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ipv6/route/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ipv6/route/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/route/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/route/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/route/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/route/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ipv6/route/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/route/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ipv6/route/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/route/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/route/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/route/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ipv6/route/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/route/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /ipv6/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ipv6/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ipv6/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ipv6/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ipv6/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ipv6/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ipv6/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ipv6/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ipv6/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ipv6/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ipv6/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/jobname

/jobname post

POST: /jobname (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/jobname post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/jobname" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/len

/len post

POST: /len (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/len post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/len" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/local

/local post

POST: /local (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/local post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/local" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/log

/log get

GET: /log (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/log get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/log" \
	--user username:password

RESPONSE BODY

Type

array

/debug post

POST: /log/debug (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/debug post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/log/debug" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/error post

POST: /log/error (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/error post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/log/error" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /log/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/log/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /log/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/log/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /log/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/log/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/info post

POST: /log/info (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/info post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/log/info" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /log/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/log/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/warning post

POST: /log/warning (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/warning post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/log/warning" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/mpls

/export post

POST: /mpls/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/forwarding-table get

GET: /mpls/forwarding-table (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/forwarding-table get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/forwarding-table" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /mpls/forwarding-table/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/forwarding-table/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /mpls/forwarding-table/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/forwarding-table/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /mpls/forwarding-table/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/forwarding-table/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /mpls/forwarding-table/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/forwarding-table/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface get

GET: /mpls/interface (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/interface" \
	--user username:password

RESPONSE BODY

Type

array

/interface put

PUT: /mpls/interface (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/mpls/interface" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /mpls/interface/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/interface/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /mpls/interface/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/interface/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /mpls/interface/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/interface/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /mpls/interface/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/interface/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /mpls/interface/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/interface/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /mpls/interface/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/interface/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /mpls/interface/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/interface/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /mpls/interface/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/interface/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /mpls/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/interface/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /mpls/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/mpls/interface/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /mpls/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/mpls/interface/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /mpls/interface/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/interface/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /mpls/interface/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/interface/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /mpls/interface/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/interface/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /mpls/interface/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/interface/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /mpls/interface/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/interface/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /mpls/interface/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/interface/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ldp get

GET: /mpls/ldp (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ldp get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/ldp" \
	--user username:password

RESPONSE BODY

Type

array

/ldp put

PUT: /mpls/ldp (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ldp put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/mpls/ldp" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/accept-filter get

GET: /mpls/ldp/accept-filter (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/accept-filter get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/ldp/accept-filter" \
	--user username:password

RESPONSE BODY

Type

array

/accept-filter put

PUT: /mpls/ldp/accept-filter (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/accept-filter put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/mpls/ldp/accept-filter" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /mpls/ldp/accept-filter/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/accept-filter/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /mpls/ldp/accept-filter/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/accept-filter/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /mpls/ldp/accept-filter/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/accept-filter/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /mpls/ldp/accept-filter/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/accept-filter/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /mpls/ldp/accept-filter/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/accept-filter/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /mpls/ldp/accept-filter/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/accept-filter/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /mpls/ldp/accept-filter/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/accept-filter/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /mpls/ldp/accept-filter/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/accept-filter/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /mpls/ldp/accept-filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/ldp/accept-filter/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /mpls/ldp/accept-filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/mpls/ldp/accept-filter/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /mpls/ldp/accept-filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/mpls/ldp/accept-filter/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /mpls/ldp/accept-filter/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/accept-filter/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /mpls/ldp/accept-filter/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/accept-filter/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /mpls/ldp/accept-filter/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/accept-filter/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /mpls/ldp/accept-filter/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/accept-filter/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /mpls/ldp/accept-filter/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/accept-filter/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /mpls/ldp/accept-filter/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/accept-filter/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /mpls/ldp/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/advertise-filter get

GET: /mpls/ldp/advertise-filter (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/advertise-filter get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/ldp/advertise-filter" \
	--user username:password

RESPONSE BODY

Type

array

/advertise-filter put

PUT: /mpls/ldp/advertise-filter (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/advertise-filter put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/mpls/ldp/advertise-filter" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /mpls/ldp/advertise-filter/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/advertise-filter/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /mpls/ldp/advertise-filter/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/advertise-filter/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /mpls/ldp/advertise-filter/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/advertise-filter/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /mpls/ldp/advertise-filter/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/advertise-filter/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /mpls/ldp/advertise-filter/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/advertise-filter/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /mpls/ldp/advertise-filter/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/advertise-filter/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /mpls/ldp/advertise-filter/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/advertise-filter/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /mpls/ldp/advertise-filter/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/advertise-filter/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /mpls/ldp/advertise-filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/ldp/advertise-filter/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /mpls/ldp/advertise-filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/mpls/ldp/advertise-filter/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /mpls/ldp/advertise-filter/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/mpls/ldp/advertise-filter/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /mpls/ldp/advertise-filter/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/advertise-filter/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /mpls/ldp/advertise-filter/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/advertise-filter/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /mpls/ldp/advertise-filter/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/advertise-filter/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /mpls/ldp/advertise-filter/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/advertise-filter/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /mpls/ldp/advertise-filter/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/advertise-filter/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /mpls/ldp/advertise-filter/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/advertise-filter/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /mpls/ldp/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /mpls/ldp/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /mpls/ldp/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /mpls/ldp/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /mpls/ldp/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /mpls/ldp/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /mpls/ldp/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /mpls/ldp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/ldp/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /mpls/ldp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/mpls/ldp/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /mpls/ldp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/mpls/ldp/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface get

GET: /mpls/ldp/interface (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/ldp/interface" \
	--user username:password

RESPONSE BODY

Type

array

/interface put

PUT: /mpls/ldp/interface (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/mpls/ldp/interface" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /mpls/ldp/interface/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/interface/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /mpls/ldp/interface/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/interface/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /mpls/ldp/interface/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/interface/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /mpls/ldp/interface/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/interface/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /mpls/ldp/interface/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/interface/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /mpls/ldp/interface/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/interface/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /mpls/ldp/interface/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/interface/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /mpls/ldp/interface/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/interface/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /mpls/ldp/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/ldp/interface/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /mpls/ldp/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/mpls/ldp/interface/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /mpls/ldp/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/mpls/ldp/interface/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /mpls/ldp/interface/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/interface/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /mpls/ldp/interface/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/interface/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /mpls/ldp/interface/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/interface/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /mpls/ldp/interface/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/interface/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /mpls/ldp/interface/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/interface/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/local-mapping get

GET: /mpls/ldp/local-mapping (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/local-mapping get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/ldp/local-mapping" \
	--user username:password

RESPONSE BODY

Type

array

/local-mapping put

PUT: /mpls/ldp/local-mapping (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/local-mapping put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/mpls/ldp/local-mapping" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /mpls/ldp/local-mapping/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/local-mapping/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /mpls/ldp/local-mapping/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/local-mapping/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /mpls/ldp/local-mapping/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/local-mapping/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /mpls/ldp/local-mapping/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/local-mapping/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /mpls/ldp/local-mapping/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/local-mapping/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /mpls/ldp/local-mapping/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/local-mapping/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /mpls/ldp/local-mapping/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/local-mapping/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /mpls/ldp/local-mapping/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/local-mapping/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /mpls/ldp/local-mapping/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/ldp/local-mapping/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /mpls/ldp/local-mapping/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/mpls/ldp/local-mapping/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /mpls/ldp/local-mapping/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/mpls/ldp/local-mapping/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /mpls/ldp/local-mapping/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/local-mapping/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /mpls/ldp/local-mapping/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/local-mapping/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /mpls/ldp/local-mapping/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/local-mapping/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /mpls/ldp/local-mapping/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/local-mapping/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /mpls/ldp/local-mapping/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/local-mapping/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/neighbor get

GET: /mpls/ldp/neighbor (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/neighbor get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/ldp/neighbor" \
	--user username:password

RESPONSE BODY

Type

array

/neighbor put

PUT: /mpls/ldp/neighbor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/neighbor put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/mpls/ldp/neighbor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /mpls/ldp/neighbor/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/neighbor/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /mpls/ldp/neighbor/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/neighbor/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /mpls/ldp/neighbor/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/neighbor/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /mpls/ldp/neighbor/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/neighbor/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /mpls/ldp/neighbor/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/neighbor/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /mpls/ldp/neighbor/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/neighbor/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /mpls/ldp/neighbor/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/neighbor/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /mpls/ldp/neighbor/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/neighbor/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /mpls/ldp/neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/ldp/neighbor/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /mpls/ldp/neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/mpls/ldp/neighbor/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /mpls/ldp/neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/mpls/ldp/neighbor/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /mpls/ldp/neighbor/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/neighbor/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /mpls/ldp/neighbor/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/neighbor/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /mpls/ldp/neighbor/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/neighbor/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /mpls/ldp/neighbor/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/neighbor/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /mpls/ldp/neighbor/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/neighbor/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /mpls/ldp/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remote-mapping get

GET: /mpls/ldp/remote-mapping (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remote-mapping get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/ldp/remote-mapping" \
	--user username:password

RESPONSE BODY

Type

array

/remote-mapping put

PUT: /mpls/ldp/remote-mapping (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remote-mapping put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/mpls/ldp/remote-mapping" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /mpls/ldp/remote-mapping/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/remote-mapping/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /mpls/ldp/remote-mapping/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/remote-mapping/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /mpls/ldp/remote-mapping/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/remote-mapping/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /mpls/ldp/remote-mapping/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/remote-mapping/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /mpls/ldp/remote-mapping/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/remote-mapping/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /mpls/ldp/remote-mapping/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/remote-mapping/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /mpls/ldp/remote-mapping/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/remote-mapping/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /mpls/ldp/remote-mapping/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/remote-mapping/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /mpls/ldp/remote-mapping/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/ldp/remote-mapping/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /mpls/ldp/remote-mapping/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/mpls/ldp/remote-mapping/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /mpls/ldp/remote-mapping/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/mpls/ldp/remote-mapping/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /mpls/ldp/remote-mapping/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/remote-mapping/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /mpls/ldp/remote-mapping/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/remote-mapping/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /mpls/ldp/remote-mapping/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/remote-mapping/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /mpls/ldp/remote-mapping/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/remote-mapping/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /mpls/ldp/remote-mapping/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/remote-mapping/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /mpls/ldp/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /mpls/ldp/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /mpls/ldp/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /mpls/ldp/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/ldp/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /mpls/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /mpls/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /mpls/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /mpls/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /mpls/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /mpls/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/mpls/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /mpls/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /mpls/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /mpls/traffic-eng/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/flow get

GET: /mpls/traffic-eng/flow (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/flow get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/traffic-eng/flow" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /mpls/traffic-eng/flow/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/flow/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /mpls/traffic-eng/flow/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/flow/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /mpls/traffic-eng/flow/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/traffic-eng/flow/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /mpls/traffic-eng/flow/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/flow/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface get

GET: /mpls/traffic-eng/interface (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/traffic-eng/interface" \
	--user username:password

RESPONSE BODY

Type

array

/interface put

PUT: /mpls/traffic-eng/interface (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/mpls/traffic-eng/interface" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /mpls/traffic-eng/interface/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/interface/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /mpls/traffic-eng/interface/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/interface/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /mpls/traffic-eng/interface/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/interface/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /mpls/traffic-eng/interface/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/interface/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /mpls/traffic-eng/interface/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/interface/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /mpls/traffic-eng/interface/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/interface/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /mpls/traffic-eng/interface/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/interface/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /mpls/traffic-eng/interface/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/interface/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /mpls/traffic-eng/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/traffic-eng/interface/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /mpls/traffic-eng/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/mpls/traffic-eng/interface/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /mpls/traffic-eng/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/mpls/traffic-eng/interface/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /mpls/traffic-eng/interface/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/interface/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /mpls/traffic-eng/interface/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/interface/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /mpls/traffic-eng/interface/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/interface/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /mpls/traffic-eng/interface/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/interface/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /mpls/traffic-eng/interface/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/interface/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/path get

GET: /mpls/traffic-eng/path (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/path get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/traffic-eng/path" \
	--user username:password

RESPONSE BODY

Type

array

/path put

PUT: /mpls/traffic-eng/path (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/path put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/mpls/traffic-eng/path" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /mpls/traffic-eng/path/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/path/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /mpls/traffic-eng/path/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/path/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /mpls/traffic-eng/path/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/path/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /mpls/traffic-eng/path/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/path/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /mpls/traffic-eng/path/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/path/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /mpls/traffic-eng/path/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/path/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /mpls/traffic-eng/path/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/path/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /mpls/traffic-eng/path/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/path/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /mpls/traffic-eng/path/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/traffic-eng/path/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /mpls/traffic-eng/path/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/mpls/traffic-eng/path/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /mpls/traffic-eng/path/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/mpls/traffic-eng/path/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /mpls/traffic-eng/path/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/path/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /mpls/traffic-eng/path/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/path/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /mpls/traffic-eng/path/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/path/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /mpls/traffic-eng/path/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/path/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /mpls/traffic-eng/path/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/path/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/tunnel get

GET: /mpls/traffic-eng/tunnel (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/tunnel get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/traffic-eng/tunnel" \
	--user username:password

RESPONSE BODY

Type

array

/tunnel put

PUT: /mpls/traffic-eng/tunnel (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/tunnel put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/mpls/traffic-eng/tunnel" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /mpls/traffic-eng/tunnel/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /mpls/traffic-eng/tunnel/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /mpls/traffic-eng/tunnel/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /mpls/traffic-eng/tunnel/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /mpls/traffic-eng/tunnel/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /mpls/traffic-eng/tunnel/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /mpls/traffic-eng/tunnel/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /mpls/traffic-eng/tunnel/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /mpls/traffic-eng/tunnel/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /mpls/traffic-eng/tunnel/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /mpls/traffic-eng/tunnel/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /mpls/traffic-eng/tunnel/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /mpls/traffic-eng/tunnel/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reoptimize post

POST: /mpls/traffic-eng/tunnel/reoptimize (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reoptimize post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/reoptimize" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /mpls/traffic-eng/tunnel/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /mpls/traffic-eng/tunnel/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /mpls/traffic-eng/tunnel/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/mpls/traffic-eng/tunnel/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/nothing

/nothing post

POST: /nothing (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/nothing post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/nothing" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/onerror

/onerror post

POST: /onerror (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/onerror post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/onerror" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/parse

/parse post

POST: /parse (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/parse post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/parse" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/password

/password post

POST: /password (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/password post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/password" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/pick

/pick post

POST: /pick (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pick post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/pick" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ping

/ping post

POST: /ping (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ping post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ping" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/port

/port get

GET: /port (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/port get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/port" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /port/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /port/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /port/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /port/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/port/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/port/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/port/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /port/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remote-access get

GET: /port/remote-access (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remote-access get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/port/remote-access" \
	--user username:password

RESPONSE BODY

Type

array

/remote-access put

PUT: /port/remote-access (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remote-access put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/port/remote-access" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /port/remote-access/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/remote-access/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /port/remote-access/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/remote-access/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /port/remote-access/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/remote-access/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /port/remote-access/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/remote-access/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /port/remote-access/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/remote-access/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /port/remote-access/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/remote-access/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /port/remote-access/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/remote-access/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /port/remote-access/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/port/remote-access/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /port/remote-access/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/port/remote-access/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /port/remote-access/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/port/remote-access/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /port/remote-access/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/remote-access/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /port/remote-access/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/remote-access/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /port/remote-access/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/remote-access/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /port/remote-access/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/remote-access/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /port/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /port/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /port/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/port/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ppp

/aaa get

GET: /ppp/aaa (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/aaa get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ppp/aaa" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /ppp/aaa/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/aaa/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ppp/aaa/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/aaa/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ppp/aaa/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/aaa/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ppp/aaa/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ppp/aaa/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ppp/aaa/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ppp/aaa/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ppp/aaa/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/aaa/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ppp/aaa/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/aaa/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/active get

GET: /ppp/active (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/active get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ppp/active" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /ppp/active/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/active/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ppp/active/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/active/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ppp/active/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ppp/active/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ppp/active/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ppp/active/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ppp/active/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/active/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ppp/active/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/active/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ppp/active/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/active/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ppp/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/l2tp-secret get

GET: /ppp/l2tp-secret (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/l2tp-secret get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ppp/l2tp-secret" \
	--user username:password

RESPONSE BODY

Type

array

/l2tp-secret put

PUT: /ppp/l2tp-secret (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/l2tp-secret put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ppp/l2tp-secret" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ppp/l2tp-secret/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/l2tp-secret/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ppp/l2tp-secret/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/l2tp-secret/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ppp/l2tp-secret/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/l2tp-secret/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ppp/l2tp-secret/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/l2tp-secret/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ppp/l2tp-secret/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/l2tp-secret/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ppp/l2tp-secret/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/l2tp-secret/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ppp/l2tp-secret/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ppp/l2tp-secret/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ppp/l2tp-secret/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ppp/l2tp-secret/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ppp/l2tp-secret/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ppp/l2tp-secret/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ppp/l2tp-secret/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/l2tp-secret/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ppp/l2tp-secret/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/l2tp-secret/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ppp/l2tp-secret/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/l2tp-secret/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ppp/l2tp-secret/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/l2tp-secret/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/profile get

GET: /ppp/profile (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/profile get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ppp/profile" \
	--user username:password

RESPONSE BODY

Type

array

/profile put

PUT: /ppp/profile (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/profile put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ppp/profile" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ppp/profile/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/profile/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ppp/profile/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/profile/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ppp/profile/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/profile/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ppp/profile/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/profile/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ppp/profile/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/profile/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ppp/profile/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/profile/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ppp/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ppp/profile/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ppp/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ppp/profile/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ppp/profile/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ppp/profile/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ppp/profile/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/profile/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ppp/profile/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/profile/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ppp/profile/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/profile/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ppp/profile/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/profile/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ppp/profile/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/profile/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/secret get

GET: /ppp/secret (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/secret get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ppp/secret" \
	--user username:password

RESPONSE BODY

Type

array

/secret put

PUT: /ppp/secret (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/secret put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/ppp/secret" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /ppp/secret/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/secret/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /ppp/secret/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/secret/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /ppp/secret/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/secret/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /ppp/secret/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/secret/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /ppp/secret/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/secret/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /ppp/secret/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/secret/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /ppp/secret/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/secret/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /ppp/secret/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/secret/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /ppp/secret/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/ppp/secret/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /ppp/secret/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/ppp/secret/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /ppp/secret/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/ppp/secret/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /ppp/secret/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/secret/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /ppp/secret/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/secret/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /ppp/secret/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/secret/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /ppp/secret/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/secret/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /ppp/secret/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/ppp/secret/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/put

/put post

POST: /put (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/put post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/put" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/queue

/export post

POST: /queue/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface get

GET: /queue/interface (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/queue/interface" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /queue/interface/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/interface/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /queue/interface/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/interface/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /queue/interface/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/interface/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /queue/interface/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/interface/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /queue/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/queue/interface/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /queue/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/queue/interface/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /queue/interface/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/interface/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /queue/interface/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/interface/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /queue/interface/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/interface/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /queue/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/simple get

GET: /queue/simple (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/simple get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/queue/simple" \
	--user username:password

RESPONSE BODY

Type

array

/simple put

PUT: /queue/simple (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/simple put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/queue/simple" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /queue/simple/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /queue/simple/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /queue/simple/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /queue/simple/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /queue/simple/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /queue/simple/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /queue/simple/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /queue/simple/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /queue/simple/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/queue/simple/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /queue/simple/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/queue/simple/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /queue/simple/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/queue/simple/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /queue/simple/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /queue/simple/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /queue/simple/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /queue/simple/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /queue/simple/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /queue/simple/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /queue/simple/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /queue/simple/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/simple/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/tree get

GET: /queue/tree (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/tree get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/queue/tree" \
	--user username:password

RESPONSE BODY

Type

array

/tree put

PUT: /queue/tree (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/tree put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/queue/tree" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /queue/tree/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/tree/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /queue/tree/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/tree/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /queue/tree/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/tree/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /queue/tree/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/tree/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /queue/tree/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/tree/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /queue/tree/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/tree/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /queue/tree/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/tree/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /queue/tree/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/tree/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /queue/tree/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/queue/tree/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /queue/tree/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/queue/tree/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /queue/tree/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/queue/tree/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /queue/tree/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/tree/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /queue/tree/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/tree/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /queue/tree/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/tree/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /queue/tree/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/tree/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters-all post

POST: /queue/tree/reset-counters-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/tree/reset-counters-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /queue/tree/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/tree/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/type get

GET: /queue/type (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/type get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/queue/type" \
	--user username:password

RESPONSE BODY

Type

array

/type put

PUT: /queue/type (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/type put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/queue/type" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /queue/type/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/type/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /queue/type/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/type/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /queue/type/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/type/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /queue/type/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/type/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /queue/type/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/type/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /queue/type/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/queue/type/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /queue/type/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/queue/type/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /queue/type/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/queue/type/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /queue/type/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/type/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /queue/type/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/type/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /queue/type/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/type/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /queue/type/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/queue/type/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/quit

/quit post

POST: /quit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/quit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/quit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/radius

/radius get

GET: /radius (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/radius get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/radius" \
	--user username:password

RESPONSE BODY

Type

array

/radius put

PUT: /radius (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/radius put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/radius" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /radius/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /radius/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /radius/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /radius/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /radius/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /radius/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /radius/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /radius/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /radius/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/radius/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /radius/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/radius/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /radius/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/radius/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/incoming get

GET: /radius/incoming (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/incoming get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/radius/incoming" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /radius/incoming/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/incoming/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /radius/incoming/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/incoming/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /radius/incoming/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/incoming/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /radius/incoming/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/radius/incoming/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /radius/incoming/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/radius/incoming/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /radius/incoming/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/incoming/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /radius/incoming/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/incoming/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /radius/incoming/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/incoming/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /radius/incoming/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/incoming/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /radius/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /radius/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /radius/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /radius/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /radius/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-counters post

POST: /radius/reset-counters (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-counters post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/reset-counters" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /radius/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/radius/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/redo

/redo post

POST: /redo (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/redo post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/redo" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/resolve

/resolve post

POST: /resolve (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/resolve post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/resolve" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/retry

/retry post

POST: /retry (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/retry post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/retry" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/return

/return post

POST: /return (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/return post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/return" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/rndnum

/rndnum post

POST: /rndnum (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rndnum post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/rndnum" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/rndstr

/rndstr post

POST: /rndstr (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rndstr post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/rndstr" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/routing

/configuration get

GET: /routing/bfd/configuration (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/configuration get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bfd/configuration" \
	--user username:password

RESPONSE BODY

Type

array

/configuration put

PUT: /routing/bfd/configuration (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/configuration put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/bfd/configuration" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/bfd/configuration/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/configuration/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/bfd/configuration/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/configuration/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/bfd/configuration/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/configuration/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/bfd/configuration/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/configuration/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/bfd/configuration/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/configuration/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/bfd/configuration/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/configuration/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/bfd/configuration/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/configuration/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/bfd/configuration/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/configuration/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/bfd/configuration/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bfd/configuration/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/bfd/configuration/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/bfd/configuration/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/bfd/configuration/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/bfd/configuration/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /routing/bfd/configuration/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/configuration/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/bfd/configuration/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/configuration/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/bfd/configuration/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/configuration/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/bfd/configuration/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/configuration/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/bfd/configuration/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/configuration/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/bfd/configuration/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/configuration/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/bfd/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/session get

GET: /routing/bfd/session (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/session get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bfd/session" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/bfd/session/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/session/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/bfd/session/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/session/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/bfd/session/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bfd/session/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/bfd/session/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bfd/session/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/advertisements get

GET: /routing/bgp/advertisements (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/advertisements get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bgp/advertisements" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/bgp/advertisements/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/advertisements/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/bgp/advertisements/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/advertisements/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/bgp/advertisements/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bgp/advertisements/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/bgp/advertisements/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/advertisements/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/connection get

GET: /routing/bgp/connection (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/connection get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bgp/connection" \
	--user username:password

RESPONSE BODY

Type

array

/connection put

PUT: /routing/bgp/connection (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/connection put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/bgp/connection" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/bgp/connection/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/connection/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/bgp/connection/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/connection/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/bgp/connection/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/connection/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/bgp/connection/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/connection/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/bgp/connection/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/connection/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/bgp/connection/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/connection/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/bgp/connection/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/connection/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/bgp/connection/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/connection/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/bgp/connection/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bgp/connection/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/bgp/connection/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/bgp/connection/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/bgp/connection/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/bgp/connection/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/bgp/connection/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/connection/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/bgp/connection/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/connection/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/bgp/connection/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/connection/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/bgp/connection/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/connection/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/bgp/connection/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/connection/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/bgp/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/session get

GET: /routing/bgp/session (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/session get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bgp/session" \
	--user username:password

RESPONSE BODY

Type

array

/clear post

POST: /routing/bgp/session/clear (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/clear post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/session/clear" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/dump-saved-advertisements post

POST: /routing/bgp/session/dump-saved-advertisements (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dump-saved-advertisements post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/session/dump-saved-advertisements" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/bgp/session/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/session/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/bgp/session/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/session/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/bgp/session/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bgp/session/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/bgp/session/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/session/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/refresh post

POST: /routing/bgp/session/refresh (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/refresh post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/session/refresh" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/resend post

POST: /routing/bgp/session/resend (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/resend post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/session/resend" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/stop post

POST: /routing/bgp/session/stop (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/stop post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/session/stop" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/bgp/session/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/session/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/template get

GET: /routing/bgp/template (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/template get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bgp/template" \
	--user username:password

RESPONSE BODY

Type

array

/template put

PUT: /routing/bgp/template (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/template put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/bgp/template" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/bgp/template/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/template/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/bgp/template/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/template/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/bgp/template/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/template/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/bgp/template/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/template/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/bgp/template/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/template/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/bgp/template/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/template/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/bgp/template/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/template/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/bgp/template/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/template/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/bgp/template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bgp/template/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/bgp/template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/bgp/template/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/bgp/template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/bgp/template/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/bgp/template/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/template/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/bgp/template/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/template/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/bgp/template/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/template/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/bgp/template/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/template/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/bgp/template/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/template/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/vpls get

GET: /routing/bgp/vpls (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vpls get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bgp/vpls" \
	--user username:password

RESPONSE BODY

Type

array

/vpls put

PUT: /routing/bgp/vpls (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vpls put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/bgp/vpls" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/bgp/vpls/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpls/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/bgp/vpls/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpls/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/bgp/vpls/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpls/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/bgp/vpls/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpls/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/bgp/vpls/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpls/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/bgp/vpls/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpls/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/bgp/vpls/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpls/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/bgp/vpls/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpls/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/bgp/vpls/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bgp/vpls/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/bgp/vpls/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/bgp/vpls/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/bgp/vpls/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/bgp/vpls/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/bgp/vpls/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpls/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/bgp/vpls/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpls/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/bgp/vpls/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpls/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/bgp/vpls/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpls/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/bgp/vpls/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpls/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/vpn get

GET: /routing/bgp/vpn (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vpn get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bgp/vpn" \
	--user username:password

RESPONSE BODY

Type

array

/vpn put

PUT: /routing/bgp/vpn (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vpn put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/bgp/vpn" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/bgp/vpn/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpn/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/bgp/vpn/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpn/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/bgp/vpn/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpn/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/bgp/vpn/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpn/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/bgp/vpn/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpn/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/bgp/vpn/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpn/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/bgp/vpn/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpn/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/bgp/vpn/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpn/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/bgp/vpn/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/bgp/vpn/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/bgp/vpn/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/bgp/vpn/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/bgp/vpn/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/bgp/vpn/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/bgp/vpn/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpn/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/bgp/vpn/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpn/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/bgp/vpn/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpn/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/bgp/vpn/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpn/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/bgp/vpn/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/bgp/vpn/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/discourse post

POST: /routing/discourse (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/discourse post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/discourse" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/fantasy get

GET: /routing/fantasy (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/fantasy get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/fantasy" \
	--user username:password

RESPONSE BODY

Type

array

/fantasy put

PUT: /routing/fantasy (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/fantasy put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/fantasy" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/fantasy/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/fantasy/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/fantasy/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/fantasy/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/fantasy/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/fantasy/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/fantasy/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/fantasy/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/fantasy/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/fantasy/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/fantasy/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/fantasy/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/fantasy/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/fantasy/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/fantasy/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/fantasy/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/fantasy/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/fantasy/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/fantasy/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/fantasy/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/fantasy/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/fantasy/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/fantasy/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/fantasy/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/fantasy/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/fantasy/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/fantasy/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/fantasy/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/fantasy/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/fantasy/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/chain get

GET: /routing/filter/chain (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/chain get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/filter/chain" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/filter/chain/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/chain/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/filter/chain/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/chain/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/filter/chain/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/filter/chain/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/filter/chain/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/chain/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/community-ext-list get

GET: /routing/filter/community-ext-list (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/community-ext-list get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/filter/community-ext-list" \
	--user username:password

RESPONSE BODY

Type

array

/community-ext-list put

PUT: /routing/filter/community-ext-list (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/community-ext-list put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/filter/community-ext-list" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/filter/community-ext-list/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-ext-list/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/filter/community-ext-list/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-ext-list/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/filter/community-ext-list/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-ext-list/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/filter/community-ext-list/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-ext-list/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/filter/community-ext-list/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-ext-list/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/filter/community-ext-list/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-ext-list/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/filter/community-ext-list/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-ext-list/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/filter/community-ext-list/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-ext-list/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/filter/community-ext-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/filter/community-ext-list/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/filter/community-ext-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/filter/community-ext-list/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/filter/community-ext-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/filter/community-ext-list/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /routing/filter/community-ext-list/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-ext-list/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/filter/community-ext-list/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-ext-list/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/filter/community-ext-list/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-ext-list/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/filter/community-ext-list/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-ext-list/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/filter/community-ext-list/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-ext-list/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/filter/community-ext-list/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-ext-list/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/community-large-list get

GET: /routing/filter/community-large-list (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/community-large-list get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/filter/community-large-list" \
	--user username:password

RESPONSE BODY

Type

array

/community-large-list put

PUT: /routing/filter/community-large-list (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/community-large-list put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/filter/community-large-list" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/filter/community-large-list/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-large-list/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/filter/community-large-list/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-large-list/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/filter/community-large-list/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-large-list/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/filter/community-large-list/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-large-list/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/filter/community-large-list/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-large-list/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/filter/community-large-list/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-large-list/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/filter/community-large-list/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-large-list/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/filter/community-large-list/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-large-list/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/filter/community-large-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/filter/community-large-list/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/filter/community-large-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/filter/community-large-list/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/filter/community-large-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/filter/community-large-list/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /routing/filter/community-large-list/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-large-list/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/filter/community-large-list/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-large-list/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/filter/community-large-list/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-large-list/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/filter/community-large-list/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-large-list/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/filter/community-large-list/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-large-list/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/filter/community-large-list/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-large-list/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/community-list get

GET: /routing/filter/community-list (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/community-list get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/filter/community-list" \
	--user username:password

RESPONSE BODY

Type

array

/community-list put

PUT: /routing/filter/community-list (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/community-list put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/filter/community-list" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/filter/community-list/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-list/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/filter/community-list/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-list/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/filter/community-list/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-list/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/filter/community-list/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-list/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/filter/community-list/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-list/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/filter/community-list/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-list/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/filter/community-list/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-list/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/filter/community-list/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-list/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/filter/community-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/filter/community-list/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/filter/community-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/filter/community-list/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/filter/community-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/filter/community-list/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /routing/filter/community-list/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-list/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/filter/community-list/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-list/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/filter/community-list/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-list/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/filter/community-list/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-list/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/filter/community-list/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-list/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/filter/community-list/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/community-list/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/filter/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/num-list get

GET: /routing/filter/num-list (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/num-list get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/filter/num-list" \
	--user username:password

RESPONSE BODY

Type

array

/num-list put

PUT: /routing/filter/num-list (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/num-list put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/filter/num-list" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/filter/num-list/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/num-list/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/filter/num-list/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/num-list/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/filter/num-list/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/num-list/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/filter/num-list/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/num-list/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/filter/num-list/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/num-list/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/filter/num-list/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/num-list/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/filter/num-list/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/num-list/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/filter/num-list/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/num-list/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/filter/num-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/filter/num-list/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/filter/num-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/filter/num-list/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/filter/num-list/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/filter/num-list/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /routing/filter/num-list/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/num-list/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/filter/num-list/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/num-list/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/filter/num-list/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/num-list/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/filter/num-list/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/num-list/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/filter/num-list/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/num-list/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/rule get

GET: /routing/filter/rule (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rule get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/filter/rule" \
	--user username:password

RESPONSE BODY

Type

array

/rule put

PUT: /routing/filter/rule (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rule put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/filter/rule" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/filter/rule/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/rule/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/filter/rule/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/rule/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/filter/rule/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/rule/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/filter/rule/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/rule/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/filter/rule/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/rule/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/filter/rule/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/rule/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/filter/rule/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/rule/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/filter/rule/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/rule/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/filter/rule/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/filter/rule/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/filter/rule/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/filter/rule/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/filter/rule/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/filter/rule/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /routing/filter/rule/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/rule/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/filter/rule/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/rule/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/filter/rule/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/rule/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/filter/rule/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/rule/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/filter/rule/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/rule/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/select-rule get

GET: /routing/filter/select-rule (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/select-rule get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/filter/select-rule" \
	--user username:password

RESPONSE BODY

Type

array

/select-rule put

PUT: /routing/filter/select-rule (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/select-rule put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/filter/select-rule" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/filter/select-rule/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/select-rule/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/filter/select-rule/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/select-rule/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/filter/select-rule/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/select-rule/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/filter/select-rule/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/select-rule/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/filter/select-rule/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/select-rule/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/filter/select-rule/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/select-rule/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/filter/select-rule/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/select-rule/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/filter/select-rule/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/select-rule/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/filter/select-rule/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/filter/select-rule/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/filter/select-rule/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/filter/select-rule/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/filter/select-rule/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/filter/select-rule/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /routing/filter/select-rule/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/select-rule/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/filter/select-rule/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/select-rule/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/filter/select-rule/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/select-rule/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/filter/select-rule/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/select-rule/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/filter/select-rule/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/select-rule/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/filter/select-rule/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/select-rule/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/test-as-path-regexp post

POST: /routing/filter/test-as-path-regexp (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/test-as-path-regexp post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/filter/test-as-path-regexp" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/gmp get

GET: /routing/gmp (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/gmp get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/gmp" \
	--user username:password

RESPONSE BODY

Type

array

/gmp put

PUT: /routing/gmp (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/gmp put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/gmp" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/gmp/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/gmp/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/gmp/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/gmp/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/gmp/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/gmp/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/gmp/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/gmp/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/gmp/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/gmp/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/gmp/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/gmp/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/gmp/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/gmp/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/gmp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/gmp/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/gmp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/gmp/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/gmp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/gmp/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/gmp/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/gmp/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/gmp/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/gmp/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/gmp/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/gmp/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/gmp/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/gmp/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/gmp/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/gmp/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/id get

GET: /routing/id (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/id get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/id" \
	--user username:password

RESPONSE BODY

Type

array

/id put

PUT: /routing/id (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/id put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/id" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/id/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/id/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/id/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/id/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/id/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/id/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/id/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/id/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/id/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/id/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/id/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/id/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/id/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/id/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/id/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/id/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/id/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/id/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/id/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/id/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/id/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/id/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/id/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/id/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/id/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/id/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/id/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/id/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/id/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/id/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/id/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/id/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/igmp-proxy get

GET: /routing/igmp-proxy (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/igmp-proxy get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/igmp-proxy" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /routing/igmp-proxy/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/igmp-proxy/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/igmp-proxy/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/igmp-proxy/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/igmp-proxy/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/igmp-proxy/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/igmp-proxy/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface get

GET: /routing/igmp-proxy/interface (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/igmp-proxy/interface" \
	--user username:password

RESPONSE BODY

Type

array

/interface put

PUT: /routing/igmp-proxy/interface (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/igmp-proxy/interface" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/igmp-proxy/interface/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/interface/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/igmp-proxy/interface/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/interface/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/igmp-proxy/interface/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/interface/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/igmp-proxy/interface/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/interface/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/igmp-proxy/interface/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/interface/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/igmp-proxy/interface/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/interface/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/igmp-proxy/interface/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/interface/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/igmp-proxy/interface/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/interface/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/igmp-proxy/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/igmp-proxy/interface/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/igmp-proxy/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/igmp-proxy/interface/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/igmp-proxy/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/igmp-proxy/interface/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/igmp-proxy/interface/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/interface/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/igmp-proxy/interface/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/interface/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/igmp-proxy/interface/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/interface/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/igmp-proxy/interface/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/interface/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/mfc get

GET: /routing/igmp-proxy/mfc (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mfc get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/igmp-proxy/mfc" \
	--user username:password

RESPONSE BODY

Type

array

/mfc put

PUT: /routing/igmp-proxy/mfc (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mfc put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/igmp-proxy/mfc" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/igmp-proxy/mfc/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/mfc/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/igmp-proxy/mfc/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/mfc/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/igmp-proxy/mfc/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/mfc/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/igmp-proxy/mfc/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/mfc/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/igmp-proxy/mfc/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/mfc/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/igmp-proxy/mfc/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/mfc/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/igmp-proxy/mfc/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/mfc/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/igmp-proxy/mfc/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/igmp-proxy/mfc/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/igmp-proxy/mfc/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/igmp-proxy/mfc/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/igmp-proxy/mfc/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/igmp-proxy/mfc/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/igmp-proxy/mfc/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/mfc/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/igmp-proxy/mfc/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/mfc/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/igmp-proxy/mfc/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/mfc/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/igmp-proxy/mfc/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/mfc/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/igmp-proxy/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/igmp-proxy/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/igmp-proxy/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/isis/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/instance get

GET: /routing/isis/instance (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/instance get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/isis/instance" \
	--user username:password

RESPONSE BODY

Type

array

/instance put

PUT: /routing/isis/instance (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/instance put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/isis/instance" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/isis/instance/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/instance/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/isis/instance/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/instance/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/isis/instance/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/instance/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/isis/instance/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/instance/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/isis/instance/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/instance/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/isis/instance/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/instance/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/isis/instance/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/instance/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/isis/instance/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/instance/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/isis/instance/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/isis/instance/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/isis/instance/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/isis/instance/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/isis/instance/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/isis/instance/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/isis/instance/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/instance/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/isis/instance/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/instance/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/isis/instance/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/instance/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/isis/instance/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/instance/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/isis/instance/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/instance/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface get

GET: /routing/isis/interface (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/isis/interface" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /routing/isis/interface/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/isis/interface/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/isis/interface/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/isis/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/isis/interface/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/isis/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/isis/interface/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/isis/interface/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/isis/interface/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/isis/interface/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/isis/interface/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface-template get

GET: /routing/isis/interface-template (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface-template get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/isis/interface-template" \
	--user username:password

RESPONSE BODY

Type

array

/interface-template put

PUT: /routing/isis/interface-template (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface-template put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/isis/interface-template" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/isis/interface-template/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface-template/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/isis/interface-template/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface-template/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/isis/interface-template/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface-template/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/isis/interface-template/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface-template/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/isis/interface-template/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface-template/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/isis/interface-template/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface-template/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/isis/interface-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/isis/interface-template/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/isis/interface-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/isis/interface-template/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/isis/interface-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/isis/interface-template/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /routing/isis/interface-template/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface-template/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/isis/interface-template/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface-template/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/isis/interface-template/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface-template/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/isis/interface-template/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface-template/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/isis/interface-template/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface-template/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/isis/interface-template/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/interface-template/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/lsp get

GET: /routing/isis/lsp (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/lsp get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/isis/lsp" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /routing/isis/lsp/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/lsp/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/isis/lsp/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/lsp/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/isis/lsp/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/lsp/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/isis/lsp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/isis/lsp/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/isis/lsp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/isis/lsp/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/isis/lsp/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/lsp/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/isis/lsp/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/lsp/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/isis/lsp/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/lsp/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/isis/lsp/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/lsp/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/neighbor get

GET: /routing/isis/neighbor (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/neighbor get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/isis/neighbor" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /routing/isis/neighbor/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/neighbor/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/isis/neighbor/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/neighbor/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/isis/neighbor/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/neighbor/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/isis/neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/isis/neighbor/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/isis/neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/isis/neighbor/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/isis/neighbor/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/neighbor/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/isis/neighbor/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/neighbor/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/isis/neighbor/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/neighbor/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/isis/neighbor/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/isis/neighbor/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/nexthop get

GET: /routing/nexthop (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/nexthop get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/nexthop" \
	--user username:password

RESPONSE BODY

Type

array

/dump-dot post

POST: /routing/nexthop/dump-dot (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dump-dot post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/nexthop/dump-dot" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/nexthop/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/nexthop/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/nexthop/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/nexthop/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/nexthop/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/nexthop/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/nexthop/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/nexthop/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/nexthop/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/nexthop/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/area get

GET: /routing/ospf/area (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/area get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/area" \
	--user username:password

RESPONSE BODY

Type

array

/area put

PUT: /routing/ospf/area (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/area put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/ospf/area" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/ospf/area/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/ospf/area/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/ospf/area/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/ospf/area/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/ospf/area/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/ospf/area/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/ospf/area/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/ospf/area/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/ospf/area/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/area/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/ospf/area/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/ospf/area/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/ospf/area/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/ospf/area/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/ospf/area/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/range get

GET: /routing/ospf/area/range (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/range get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/area/range" \
	--user username:password

RESPONSE BODY

Type

array

/range put

PUT: /routing/ospf/area/range (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/range put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/ospf/area/range" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/ospf/area/range/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/range/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/ospf/area/range/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/range/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/ospf/area/range/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/range/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/ospf/area/range/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/range/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/ospf/area/range/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/range/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/ospf/area/range/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/range/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/ospf/area/range/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/range/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/ospf/area/range/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/range/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/ospf/area/range/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/area/range/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/ospf/area/range/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/ospf/area/range/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/ospf/area/range/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/ospf/area/range/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/ospf/area/range/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/range/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/ospf/area/range/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/range/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/ospf/area/range/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/range/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/ospf/area/range/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/range/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/ospf/area/range/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/range/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/ospf/area/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/ospf/area/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/ospf/area/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/ospf/area/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/area/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/ospf/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/instance get

GET: /routing/ospf/instance (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/instance get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/instance" \
	--user username:password

RESPONSE BODY

Type

array

/instance put

PUT: /routing/ospf/instance (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/instance put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/ospf/instance" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/ospf/instance/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/instance/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/ospf/instance/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/instance/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/ospf/instance/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/instance/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/ospf/instance/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/instance/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/ospf/instance/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/instance/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/ospf/instance/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/instance/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/ospf/instance/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/instance/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/ospf/instance/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/instance/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/ospf/instance/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/instance/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/ospf/instance/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/ospf/instance/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/ospf/instance/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/ospf/instance/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/ospf/instance/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/instance/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/ospf/instance/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/instance/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/ospf/instance/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/instance/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/ospf/instance/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/instance/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/ospf/instance/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/instance/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface get

GET: /routing/ospf/interface (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/interface" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/ospf/interface/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/ospf/interface/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/ospf/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/interface/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/ospf/interface/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface-template get

GET: /routing/ospf/interface-template (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface-template get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/interface-template" \
	--user username:password

RESPONSE BODY

Type

array

/interface-template put

PUT: /routing/ospf/interface-template (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface-template put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/ospf/interface-template" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/ospf/interface-template/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface-template/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/ospf/interface-template/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface-template/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/ospf/interface-template/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface-template/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/ospf/interface-template/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface-template/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/ospf/interface-template/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface-template/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/ospf/interface-template/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface-template/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/ospf/interface-template/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface-template/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/ospf/interface-template/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface-template/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/ospf/interface-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/interface-template/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/ospf/interface-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/ospf/interface-template/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/ospf/interface-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/ospf/interface-template/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /routing/ospf/interface-template/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface-template/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/ospf/interface-template/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface-template/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/ospf/interface-template/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface-template/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/ospf/interface-template/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface-template/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/ospf/interface-template/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface-template/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/ospf/interface-template/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/interface-template/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/lsa get

GET: /routing/ospf/lsa (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/lsa get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/lsa" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/ospf/lsa/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/lsa/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/ospf/lsa/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/lsa/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/ospf/lsa/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/lsa/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/ospf/lsa/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/lsa/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/neighbor get

GET: /routing/ospf/neighbor (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/neighbor get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/neighbor" \
	--user username:password

RESPONSE BODY

Type

array

/comment post

POST: /routing/ospf/neighbor/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/neighbor/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/ospf/neighbor/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/neighbor/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/ospf/neighbor/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/neighbor/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/ospf/neighbor/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/neighbor/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/ospf/neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/neighbor/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/ospf/neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/ospf/neighbor/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/ospf/neighbor/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/neighbor/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/ospf/neighbor/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/neighbor/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/ospf/neighbor/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/neighbor/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/static-neighbor get

GET: /routing/ospf/static-neighbor (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/static-neighbor get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/static-neighbor" \
	--user username:password

RESPONSE BODY

Type

array

/static-neighbor put

PUT: /routing/ospf/static-neighbor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/static-neighbor put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/ospf/static-neighbor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/ospf/static-neighbor/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/static-neighbor/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/ospf/static-neighbor/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/static-neighbor/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/ospf/static-neighbor/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/static-neighbor/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/ospf/static-neighbor/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/static-neighbor/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/ospf/static-neighbor/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/static-neighbor/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/ospf/static-neighbor/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/static-neighbor/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/ospf/static-neighbor/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/static-neighbor/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/ospf/static-neighbor/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/static-neighbor/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/ospf/static-neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/ospf/static-neighbor/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/ospf/static-neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/ospf/static-neighbor/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/ospf/static-neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/ospf/static-neighbor/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/ospf/static-neighbor/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/static-neighbor/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/ospf/static-neighbor/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/static-neighbor/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/ospf/static-neighbor/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/static-neighbor/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/ospf/static-neighbor/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/ospf/static-neighbor/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/bsr get

GET: /routing/pimsm/bsr (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/bsr get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/bsr" \
	--user username:password

RESPONSE BODY

Type

array

/candidate get

GET: /routing/pimsm/bsr/candidate (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/candidate get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/bsr/candidate" \
	--user username:password

RESPONSE BODY

Type

array

/candidate put

PUT: /routing/pimsm/bsr/candidate (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/candidate put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/pimsm/bsr/candidate" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/pimsm/bsr/candidate/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/pimsm/bsr/candidate/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/pimsm/bsr/candidate/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/pimsm/bsr/candidate/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/pimsm/bsr/candidate/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/pimsm/bsr/candidate/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/pimsm/bsr/candidate/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/pimsm/bsr/candidate/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/pimsm/bsr/candidate/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/pimsm/bsr/candidate/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/pimsm/bsr/candidate/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/pimsm/bsr/candidate/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/pimsm/bsr/candidate/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/pimsm/bsr/candidate/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/pimsm/bsr/candidate/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/candidate/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/pimsm/bsr/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/pimsm/bsr/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/pimsm/bsr/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/bsr/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/pimsm/bsr/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/rp-candidate get

GET: /routing/pimsm/bsr/rp-candidate (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rp-candidate get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate" \
	--user username:password

RESPONSE BODY

Type

array

/rp-candidate put

PUT: /routing/pimsm/bsr/rp-candidate (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rp-candidate put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/pimsm/bsr/rp-candidate/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/pimsm/bsr/rp-candidate/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/pimsm/bsr/rp-candidate/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/pimsm/bsr/rp-candidate/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/pimsm/bsr/rp-candidate/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/pimsm/bsr/rp-candidate/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/pimsm/bsr/rp-candidate/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/pimsm/bsr/rp-candidate/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/pimsm/bsr/rp-candidate/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/pimsm/bsr/rp-candidate/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/pimsm/bsr/rp-candidate/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/pimsm/bsr/rp-candidate/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/pimsm/bsr/rp-candidate/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/pimsm/bsr/rp-candidate/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/rp-candidate/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/rp-set get

GET: /routing/pimsm/bsr/rp-set (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rp-set get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/bsr/rp-set" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/pimsm/bsr/rp-set/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/rp-set/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/pimsm/bsr/rp-set/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/rp-set/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/pimsm/bsr/rp-set/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/bsr/rp-set/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/pimsm/bsr/rp-set/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/rp-set/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/pimsm/bsr/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/bsr/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/pimsm/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/igmp-interface-template get

GET: /routing/pimsm/igmp-interface-template (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/igmp-interface-template get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/igmp-interface-template" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /routing/pimsm/igmp-interface-template/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/igmp-interface-template/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/pimsm/igmp-interface-template/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/igmp-interface-template/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/pimsm/igmp-interface-template/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/igmp-interface-template/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/pimsm/igmp-interface-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/igmp-interface-template/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/pimsm/igmp-interface-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/pimsm/igmp-interface-template/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/pimsm/igmp-interface-template/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/igmp-interface-template/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/pimsm/igmp-interface-template/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/igmp-interface-template/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/pimsm/igmp-interface-template/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/igmp-interface-template/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/pimsm/igmp-interface-template/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/igmp-interface-template/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/instance get

GET: /routing/pimsm/instance (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/instance get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/instance" \
	--user username:password

RESPONSE BODY

Type

array

/instance put

PUT: /routing/pimsm/instance (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/instance put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/pimsm/instance" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/pimsm/instance/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/instance/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/pimsm/instance/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/instance/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/pimsm/instance/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/instance/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/pimsm/instance/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/instance/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/pimsm/instance/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/instance/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/pimsm/instance/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/instance/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/pimsm/instance/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/instance/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/pimsm/instance/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/instance/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/pimsm/instance/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/pimsm/instance/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/pimsm/instance/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/pimsm/instance/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/pimsm/instance/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/instance/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/pimsm/instance/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/instance/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/pimsm/instance/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/instance/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/pimsm/instance/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/instance/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface get

GET: /routing/pimsm/interface (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/interface" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/pimsm/interface/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/pimsm/interface/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/pimsm/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/interface/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/pimsm/interface/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/pimsm/interface/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface-template get

GET: /routing/pimsm/interface-template (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface-template get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/interface-template" \
	--user username:password

RESPONSE BODY

Type

array

/interface-template put

PUT: /routing/pimsm/interface-template (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface-template put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/pimsm/interface-template" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/pimsm/interface-template/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface-template/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/pimsm/interface-template/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface-template/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/pimsm/interface-template/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface-template/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/pimsm/interface-template/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface-template/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/pimsm/interface-template/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface-template/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/pimsm/interface-template/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface-template/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/pimsm/interface-template/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface-template/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/pimsm/interface-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/interface-template/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/pimsm/interface-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/pimsm/interface-template/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/pimsm/interface-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/pimsm/interface-template/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /routing/pimsm/interface-template/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface-template/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/pimsm/interface-template/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface-template/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/pimsm/interface-template/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface-template/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/pimsm/interface-template/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface-template/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/pimsm/interface-template/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface-template/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/pimsm/interface-template/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/interface-template/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/neighbor get

GET: /routing/pimsm/neighbor (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/neighbor get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/neighbor" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/pimsm/neighbor/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/neighbor/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/pimsm/neighbor/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/neighbor/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/pimsm/neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/neighbor/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/pimsm/neighbor/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/neighbor/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/static-rp get

GET: /routing/pimsm/static-rp (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/static-rp get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/static-rp" \
	--user username:password

RESPONSE BODY

Type

array

/static-rp put

PUT: /routing/pimsm/static-rp (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/static-rp put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/pimsm/static-rp" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/pimsm/static-rp/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/static-rp/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/pimsm/static-rp/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/static-rp/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/pimsm/static-rp/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/static-rp/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/pimsm/static-rp/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/static-rp/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/pimsm/static-rp/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/static-rp/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/pimsm/static-rp/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/static-rp/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/pimsm/static-rp/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/static-rp/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/pimsm/static-rp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/static-rp/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/pimsm/static-rp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/pimsm/static-rp/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/pimsm/static-rp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/pimsm/static-rp/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/pimsm/static-rp/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/static-rp/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/pimsm/static-rp/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/static-rp/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/pimsm/static-rp/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/static-rp/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/pimsm/static-rp/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/static-rp/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/uib-g get

GET: /routing/pimsm/uib-g (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/uib-g get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/uib-g" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/pimsm/uib-g/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/uib-g/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/pimsm/uib-g/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/uib-g/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/pimsm/uib-g/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/uib-g/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/pimsm/uib-g/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/uib-g/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/uib-sg get

GET: /routing/pimsm/uib-sg (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/uib-sg get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/uib-sg" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/pimsm/uib-sg/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/uib-sg/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/pimsm/uib-sg/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/uib-sg/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/pimsm/uib-sg/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/pimsm/uib-sg/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/pimsm/uib-sg/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/pimsm/uib-sg/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reinstall-fib post

POST: /routing/reinstall-fib (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reinstall-fib post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/reinstall-fib" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/rip/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/instance get

GET: /routing/rip/instance (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/instance get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rip/instance" \
	--user username:password

RESPONSE BODY

Type

array

/instance put

PUT: /routing/rip/instance (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/instance put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/rip/instance" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/rip/instance/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/instance/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/rip/instance/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/instance/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/rip/instance/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/instance/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/rip/instance/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/instance/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/rip/instance/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/instance/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/rip/instance/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/instance/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/rip/instance/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/instance/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/rip/instance/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rip/instance/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/rip/instance/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/rip/instance/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/rip/instance/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/rip/instance/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/rip/instance/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/instance/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/rip/instance/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/instance/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/rip/instance/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/instance/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/rip/instance/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/instance/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/rip/instance/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/instance/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface get

GET: /routing/rip/interface (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rip/interface" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/rip/interface/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/rip/interface/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/rip/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rip/interface/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/rip/interface/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface-template get

GET: /routing/rip/interface-template (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface-template get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rip/interface-template" \
	--user username:password

RESPONSE BODY

Type

array

/interface-template put

PUT: /routing/rip/interface-template (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface-template put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/rip/interface-template" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/rip/interface-template/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface-template/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/rip/interface-template/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface-template/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/rip/interface-template/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface-template/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/rip/interface-template/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface-template/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/rip/interface-template/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface-template/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/rip/interface-template/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface-template/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/rip/interface-template/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface-template/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/rip/interface-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rip/interface-template/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/rip/interface-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/rip/interface-template/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/rip/interface-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/rip/interface-template/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/rip/interface-template/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface-template/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/rip/interface-template/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface-template/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/rip/interface-template/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface-template/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/rip/interface-template/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface-template/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/rip/interface-template/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/interface-template/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/keys get

GET: /routing/rip/keys (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/keys get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rip/keys" \
	--user username:password

RESPONSE BODY

Type

array

/keys put

PUT: /routing/rip/keys (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/keys put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/rip/keys" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/rip/keys/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/keys/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/rip/keys/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/keys/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/rip/keys/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/keys/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/rip/keys/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/keys/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/rip/keys/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/keys/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/rip/keys/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/keys/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/rip/keys/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/keys/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/rip/keys/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rip/keys/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/rip/keys/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/rip/keys/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/rip/keys/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/rip/keys/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/rip/keys/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/keys/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/rip/keys/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/keys/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/rip/keys/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/keys/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/rip/keys/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/keys/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/neighbor get

GET: /routing/rip/neighbor (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/neighbor get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rip/neighbor" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/rip/neighbor/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/neighbor/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/rip/neighbor/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/neighbor/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/rip/neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rip/neighbor/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/rip/neighbor/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/neighbor/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/static-neighbor get

GET: /routing/rip/static-neighbor (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/static-neighbor get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rip/static-neighbor" \
	--user username:password

RESPONSE BODY

Type

array

/static-neighbor put

PUT: /routing/rip/static-neighbor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/static-neighbor put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/rip/static-neighbor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/rip/static-neighbor/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/static-neighbor/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/rip/static-neighbor/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/static-neighbor/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/rip/static-neighbor/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/static-neighbor/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/rip/static-neighbor/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/static-neighbor/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/rip/static-neighbor/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/static-neighbor/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/rip/static-neighbor/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/static-neighbor/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/rip/static-neighbor/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/static-neighbor/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/rip/static-neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rip/static-neighbor/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/rip/static-neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/rip/static-neighbor/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/rip/static-neighbor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/rip/static-neighbor/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/rip/static-neighbor/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/static-neighbor/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/rip/static-neighbor/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/static-neighbor/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/rip/static-neighbor/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/static-neighbor/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/rip/static-neighbor/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rip/static-neighbor/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/route get

GET: /routing/route (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/route get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/route" \
	--user username:password

RESPONSE BODY

Type

array

/comment post

POST: /routing/route/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/route/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/route/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/route/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/route/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/route/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/route/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/route/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/route/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/route/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/route/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/route/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/rule get

GET: /routing/route/rule (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rule get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/route/rule" \
	--user username:password

RESPONSE BODY

Type

array

/comment post

POST: /routing/route/rule/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/rule/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/route/rule/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/rule/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/route/rule/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/rule/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/route/rule/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/rule/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/route/rule/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/rule/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/route/rule/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/rule/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/route/rule/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/route/rule/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/route/rule/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/route/rule/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /routing/route/rule/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/rule/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/route/rule/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/rule/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/route/rule/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/rule/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/route/rule/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/rule/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/route/rule/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/rule/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/route/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/route/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/route/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/rpki get

GET: /routing/rpki (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rpki get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rpki" \
	--user username:password

RESPONSE BODY

Type

array

/rpki put

PUT: /routing/rpki (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rpki put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/rpki" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/rpki/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/rpki/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/rpki/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/rpki/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/rpki/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/rpki/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/rpki/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/rpki/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/rpki/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rpki/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/rpki/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/rpki/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/rpki/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/rpki/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/rpki/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/rpki/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/rpki/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/rpki-check post

POST: /routing/rpki/rpki-check (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rpki-check post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/rpki-check" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/rpki-query post

POST: /routing/rpki/rpki-query (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rpki-query post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/rpki-query" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/session get

GET: /routing/rpki/session (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/session get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rpki/session" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/rpki/session/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/session/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/rpki/session/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/session/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/rpki/session/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rpki/session/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/rpki/session/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/session/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/rpki/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/rpki/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rpki/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/rule get

GET: /routing/rule (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rule get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rule" \
	--user username:password

RESPONSE BODY

Type

array

/rule put

PUT: /routing/rule (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rule put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/rule" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/rule/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rule/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/rule/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rule/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/rule/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rule/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/rule/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rule/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/rule/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rule/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/rule/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rule/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/rule/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rule/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/rule/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rule/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/rule/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/rule/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/rule/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/rule/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/rule/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/rule/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/move post

POST: /routing/rule/move (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/move post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rule/move" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/rule/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rule/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/rule/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rule/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/rule/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rule/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/rule/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rule/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/rule/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/rule/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /routing/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /routing/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/info post

POST: /routing/stats/info (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/info post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/info" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/memory get

GET: /routing/stats/memory (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/memory get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/stats/memory" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/stats/memory/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/memory/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/stats/memory/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/memory/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/stats/memory/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/stats/memory/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/stats/memory/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/memory/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/origin get

GET: /routing/stats/origin (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/origin get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/stats/origin" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/stats/origin/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/origin/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/stats/origin/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/origin/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/stats/origin/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/stats/origin/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/stats/origin/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/origin/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/pcap get

GET: /routing/stats/pcap (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pcap get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/stats/pcap" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/stats/pcap/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/pcap/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/stats/pcap/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/pcap/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/stats/pcap/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/stats/pcap/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/stats/pcap/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/pcap/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/process get

GET: /routing/stats/process (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/process get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/stats/process" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/stats/process/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/process/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/stats/process/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/process/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/stats/process/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/stats/process/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/kill post

POST: /routing/stats/process/kill (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/kill post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/process/kill" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/stats/process/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/process/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/step get

GET: /routing/stats/step (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/step get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/stats/step" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /routing/stats/step/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/step/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/stats/step/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/step/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/stats/step/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/stats/step/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /routing/stats/step/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/stats/step/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/table get

GET: /routing/table (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/table get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/table" \
	--user username:password

RESPONSE BODY

Type

array

/table put

PUT: /routing/table (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/table put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/routing/table" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /routing/table/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/table/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /routing/table/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/table/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /routing/table/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/table/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /routing/table/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/table/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /routing/table/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/table/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /routing/table/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/table/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /routing/table/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/table/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /routing/table/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/table/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /routing/table/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/routing/table/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /routing/table/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/routing/table/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /routing/table/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/routing/table/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /routing/table/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/table/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /routing/table/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/table/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /routing/table/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/table/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /routing/table/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/table/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /routing/table/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/routing/table/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/serialize

/serialize post

POST: /serialize (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/serialize post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/serialize" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set

/set post

POST: /set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id}

/{id} patch

PATCH: /{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/snmp

/snmp get

GET: /snmp (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/snmp get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/snmp" \
	--user username:password

RESPONSE BODY

Type

array

/community get

GET: /snmp/community (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/community get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/snmp/community" \
	--user username:password

RESPONSE BODY

Type

array

/community put

PUT: /snmp/community (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/community put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/snmp/community" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /snmp/community/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/community/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /snmp/community/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/community/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /snmp/community/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/community/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /snmp/community/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/community/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /snmp/community/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/community/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /snmp/community/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/community/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /snmp/community/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/community/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /snmp/community/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/community/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /snmp/community/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/snmp/community/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /snmp/community/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/snmp/community/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /snmp/community/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/snmp/community/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /snmp/community/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/community/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /snmp/community/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/community/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /snmp/community/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/community/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /snmp/community/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/community/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /snmp/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /snmp/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /snmp/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /snmp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/snmp/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /snmp/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/snmp/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /snmp/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/send-trap post

POST: /snmp/send-trap (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/send-trap post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/send-trap" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /snmp/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/snmp/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

GET: /special-login (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/special-login" \
	--user username:password

RESPONSE BODY

Type

array

PUT: /special-login (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/special-login" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /special-login/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/special-login/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /special-login/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/special-login/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /special-login/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/special-login/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /special-login/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/special-login/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /special-login/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/special-login/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /special-login/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/special-login/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /special-login/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/special-login/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /special-login/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/special-login/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /special-login/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/special-login/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /special-login/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/special-login/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /special-login/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/special-login/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /special-login/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/special-login/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /special-login/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/special-login/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /special-login/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/special-login/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/system

/cloud get

GET: /system/backup/cloud (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/cloud get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/backup/cloud" \
	--user username:password

RESPONSE BODY

Type

array

/download-file post

POST: /system/backup/cloud/download-file (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/download-file post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/backup/cloud/download-file" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/backup/cloud/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/backup/cloud/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/backup/cloud/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/backup/cloud/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/backup/cloud/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/backup/cloud/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /system/backup/cloud/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/backup/cloud/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove-file post

POST: /system/backup/cloud/remove-file (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove-file post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/backup/cloud/remove-file" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/upload-file post

POST: /system/backup/cloud/upload-file (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/upload-file post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/backup/cloud/upload-file" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/load post

POST: /system/backup/load (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/load post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/backup/load" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/save post

POST: /system/backup/save (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/save post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/backup/save" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/check-disk post

POST: /system/check-disk (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/check-disk post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/check-disk" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/check-installation post

POST: /system/check-installation (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/check-installation post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/check-installation" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/clock get

GET: /system/clock (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/clock get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/clock" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /system/clock/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/clock/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/clock/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/clock/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/clock/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/clock/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/clock/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/clock/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/clock/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/clock/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/manual get

GET: /system/clock/manual (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/manual get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/clock/manual" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /system/clock/manual/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/clock/manual/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/clock/manual/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/clock/manual/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/clock/manual/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/clock/manual/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/clock/manual/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/clock/manual/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/clock/manual/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/clock/manual/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/clock/manual/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/clock/manual/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/clock/manual/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/clock/manual/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/clock/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/clock/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/clock/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/clock/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/console get

GET: /system/console (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/console get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/console" \
	--user username:password

RESPONSE BODY

Type

array

/console put

PUT: /system/console (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/console put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/system/console" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /system/console/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /system/console/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/console/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /system/console/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/console/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/console/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/console/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/console/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/console/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /system/console/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/system/console/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/console/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/console/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/console/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /system/console/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/console/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/screen get

GET: /system/console/screen (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/screen get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/console/screen" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /system/console/screen/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/screen/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/console/screen/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/screen/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/console/screen/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/screen/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/console/screen/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/console/screen/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/console/screen/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/console/screen/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/console/screen/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/screen/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/console/screen/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/screen/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/console/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/console/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/default-configuration get

GET: /system/default-configuration (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/default-configuration get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/default-configuration" \
	--user username:password

RESPONSE BODY

Type

array

/caps-mode-script get

GET: /system/default-configuration/caps-mode-script (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/caps-mode-script get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/default-configuration/caps-mode-script" \
	--user username:password

RESPONSE BODY

Type

array

/get post

POST: /system/default-configuration/caps-mode-script/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/default-configuration/caps-mode-script/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/default-configuration/caps-mode-script/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/default-configuration/caps-mode-script/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /system/default-configuration/caps-mode-script/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/default-configuration/caps-mode-script/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/custom-script get

GET: /system/default-configuration/custom-script (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/custom-script get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/default-configuration/custom-script" \
	--user username:password

RESPONSE BODY

Type

array

/get post

POST: /system/default-configuration/custom-script/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/default-configuration/custom-script/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/default-configuration/custom-script/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/default-configuration/custom-script/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /system/default-configuration/custom-script/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/default-configuration/custom-script/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/default-configuration/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/default-configuration/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/default-configuration/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/default-configuration/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /system/default-configuration/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/default-configuration/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/script get

GET: /system/default-configuration/script (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/script get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/default-configuration/script" \
	--user username:password

RESPONSE BODY

Type

array

/get post

POST: /system/default-configuration/script/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/default-configuration/script/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/default-configuration/script/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/default-configuration/script/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /system/default-configuration/script/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/default-configuration/script/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/device-mode get

GET: /system/device-mode (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/device-mode get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/device-mode" \
	--user username:password

RESPONSE BODY

Type

array

/get post

POST: /system/device-mode/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/device-mode/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/device-mode/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/device-mode/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /system/device-mode/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/device-mode/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/update post

POST: /system/device-mode/update (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/update post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/device-mode/update" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/hardware get

GET: /system/hardware (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/hardware get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/hardware" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /system/hardware/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/hardware/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/hardware/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/hardware/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/hardware/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/hardware/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/hardware/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/hardware/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/hardware/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/hardware/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/hardware/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/hardware/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/hardware/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/hardware/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/health get

GET: /system/health (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/health get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/health" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /system/health/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/health/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/health/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/health/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/health/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/health/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/health/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/health/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/health/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/health/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/health/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/health/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/health/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/health/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/history get

GET: /system/history (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/history get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/history" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /system/history/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/history/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/history/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/history/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/history/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/history/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /system/history/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/history/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/identity get

GET: /system/identity (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/identity get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/identity" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /system/identity/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/identity/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/identity/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/identity/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/identity/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/identity/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/identity/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/identity/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/identity/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/identity/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/identity/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/identity/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/identity/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/identity/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/leds get

GET: /system/leds (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/leds get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/leds" \
	--user username:password

RESPONSE BODY

Type

array

/leds put

PUT: /system/leds (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/leds put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/system/leds" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /system/leds/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /system/leds/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/leds/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /system/leds/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/leds/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/leds/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/leds/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/leds/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/leds/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /system/leds/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/system/leds/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/leds/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/leds/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/leds/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /system/leds/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/leds/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/leds/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /system/leds/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/leds/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /system/leds/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/leds/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/leds/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/leds/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/leds/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/leds/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/leds/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/leds/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/leds/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/leds/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/license get

GET: /system/license (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/license get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/license" \
	--user username:password

RESPONSE BODY

Type

array

/generate-new-id post

POST: /system/license/generate-new-id (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/generate-new-id post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/license/generate-new-id" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/license/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/license/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/license/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/license/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /system/license/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/license/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/renew post

POST: /system/license/renew (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/renew post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/license/renew" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/logging get

GET: /system/logging (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/logging get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/logging" \
	--user username:password

RESPONSE BODY

Type

array

/logging put

PUT: /system/logging (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/logging put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/system/logging" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/action get

GET: /system/logging/action (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/action get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/logging/action" \
	--user username:password

RESPONSE BODY

Type

array

/action put

PUT: /system/logging/action (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/action put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/system/logging/action" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /system/logging/action/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/action/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /system/logging/action/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/action/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/logging/action/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/action/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/logging/action/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/action/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/logging/action/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/action/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/logging/action/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/action/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/logging/action/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/logging/action/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /system/logging/action/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/system/logging/action/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/logging/action/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/logging/action/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/logging/action/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/action/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /system/logging/action/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/action/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/logging/action/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/action/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/logging/action/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/action/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /system/logging/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /system/logging/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/logging/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /system/logging/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/logging/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/logging/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/logging/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/logging/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/logging/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /system/logging/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/system/logging/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/logging/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/logging/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/logging/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /system/logging/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/logging/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/logging/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/logging/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/note get

GET: /system/note (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/note get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/note" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /system/note/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/note/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/note/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/note/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/note/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/note/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/note/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/note/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/note/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/note/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/note/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/note/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/note/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/note/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/client get

GET: /system/ntp/client (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/client get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/ntp/client" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /system/ntp/client/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/ntp/client/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/ntp/client/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/ntp/client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/ntp/client/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/ntp/client/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/ntp/client/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/ntp/client/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-freq-drift post

POST: /system/ntp/client/reset-freq-drift (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-freq-drift post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/reset-freq-drift" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/servers get

GET: /system/ntp/client/servers (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/servers get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/ntp/client/servers" \
	--user username:password

RESPONSE BODY

Type

array

/servers put

PUT: /system/ntp/client/servers (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/servers put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/system/ntp/client/servers" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /system/ntp/client/servers/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/servers/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /system/ntp/client/servers/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/servers/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /system/ntp/client/servers/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/servers/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/ntp/client/servers/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/servers/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /system/ntp/client/servers/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/servers/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/ntp/client/servers/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/servers/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/ntp/client/servers/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/servers/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/ntp/client/servers/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/servers/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/ntp/client/servers/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/ntp/client/servers/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /system/ntp/client/servers/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/system/ntp/client/servers/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/ntp/client/servers/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/ntp/client/servers/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/ntp/client/servers/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/servers/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /system/ntp/client/servers/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/servers/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/ntp/client/servers/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/servers/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/ntp/client/servers/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/servers/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/ntp/client/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/client/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/ntp/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/key get

GET: /system/ntp/key (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/key get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/ntp/key" \
	--user username:password

RESPONSE BODY

Type

array

/key put

PUT: /system/ntp/key (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/key put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/system/ntp/key" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /system/ntp/key/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/key/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /system/ntp/key/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/key/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/ntp/key/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/key/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/ntp/key/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/key/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/ntp/key/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/key/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/ntp/key/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/key/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/ntp/key/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/ntp/key/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /system/ntp/key/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/system/ntp/key/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/ntp/key/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/ntp/key/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/ntp/key/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/key/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /system/ntp/key/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/key/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/ntp/key/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/key/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/ntp/key/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/key/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor-peers post

POST: /system/ntp/monitor-peers (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor-peers post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/monitor-peers" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/server get

GET: /system/ntp/server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/ntp/server" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /system/ntp/server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/ntp/server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/ntp/server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/ntp/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/ntp/server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/ntp/server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/ntp/server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/ntp/server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/ntp/server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ntp/server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/package get

GET: /system/package (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/package get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/package" \
	--user username:password

RESPONSE BODY

Type

array

/disable post

POST: /system/package/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/downgrade post

POST: /system/package/downgrade (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/downgrade post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/downgrade" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /system/package/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/package/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/package/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/package/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/package/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/package/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /system/package/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/uninstall post

POST: /system/package/uninstall (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/uninstall post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/uninstall" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unschedule post

POST: /system/package/unschedule (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unschedule post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/unschedule" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/update get

GET: /system/package/update (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/update get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/package/update" \
	--user username:password

RESPONSE BODY

Type

array

/cancel post

POST: /system/package/update/cancel (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/cancel post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/update/cancel" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/check-for-updates post

POST: /system/package/update/check-for-updates (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/check-for-updates post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/update/check-for-updates" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/download post

POST: /system/package/update/download (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/download post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/update/download" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/package/update/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/update/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/package/update/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/update/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/package/update/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/update/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/package/update/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/package/update/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/package/update/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/package/update/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/install post

POST: /system/package/update/install (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/install post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/update/install" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/package/update/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/update/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/package/update/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/package/update/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reboot post

POST: /system/reboot (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reboot post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/reboot" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset-configuration post

POST: /system/reset-configuration (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset-configuration post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/reset-configuration" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/resource get

GET: /system/resource (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/resource get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/resource" \
	--user username:password

RESPONSE BODY

Type

array

/cpu get

GET: /system/resource/cpu (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/cpu get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/resource/cpu" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /system/resource/cpu/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/cpu/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/resource/cpu/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/cpu/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/resource/cpu/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/resource/cpu/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /system/resource/cpu/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/cpu/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/resource/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/resource/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/resource/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/resource/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/irq get

GET: /system/resource/irq (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/irq get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/resource/irq" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /system/resource/irq/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/resource/irq/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/resource/irq/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/resource/irq/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/resource/irq/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/resource/irq/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/resource/irq/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/resource/irq/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/resource/irq/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/resource/irq/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/rps get

GET: /system/resource/irq/rps (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rps get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/resource/irq/rps" \
	--user username:password

RESPONSE BODY

Type

array

/disable post

POST: /system/resource/irq/rps/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/rps/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/resource/irq/rps/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/rps/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /system/resource/irq/rps/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/rps/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/resource/irq/rps/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/rps/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/resource/irq/rps/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/rps/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/resource/irq/rps/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/rps/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/resource/irq/rps/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/resource/irq/rps/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/resource/irq/rps/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/resource/irq/rps/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/resource/irq/rps/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/rps/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/resource/irq/rps/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/rps/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/resource/irq/rps/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/rps/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/resource/irq/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/irq/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /system/resource/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/pci get

GET: /system/resource/pci (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/pci get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/resource/pci" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /system/resource/pci/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/pci/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/resource/pci/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/pci/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/resource/pci/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/resource/pci/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /system/resource/pci/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/pci/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/usb-power-reset post

POST: /system/resource/pci/usb-power-reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/usb-power-reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/pci/usb-power-reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/resource/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/usb get

GET: /system/resource/usb (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/usb get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/resource/usb" \
	--user username:password

RESPONSE BODY

Type

array

/authorize post

POST: /system/resource/usb/authorize (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/authorize post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/usb/authorize" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/resource/usb/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/usb/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/resource/usb/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/usb/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/resource/usb/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/usb/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/resource/usb/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/usb/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/resource/usb/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/resource/usb/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/resource/usb/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/resource/usb/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/resource/usb/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/usb/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/resource/usb/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/usb/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /system/resource/usb/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/resource/usb/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /system/resource/usb/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/usb/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/resource/usb/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/usb/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/resource/usb/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/usb/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/resource/usb/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/resource/usb/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/resource/usb/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/resource/usb/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/resource/usb/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/usb/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/resource/usb/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/resource/usb/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/rtrace get

GET: /system/rtrace (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rtrace get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/rtrace" \
	--user username:password

RESPONSE BODY

Type

array

/get post

POST: /system/rtrace/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/rtrace/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/rtrace/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/rtrace/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /system/rtrace/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/rtrace/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/start post

POST: /system/rtrace/start (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/start post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/rtrace/start" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/stop post

POST: /system/rtrace/stop (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/stop post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/rtrace/stop" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/scheduler get

GET: /system/scheduler (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/scheduler get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/scheduler" \
	--user username:password

RESPONSE BODY

Type

array

/scheduler put

PUT: /system/scheduler (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/scheduler put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/system/scheduler" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /system/scheduler/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/scheduler/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /system/scheduler/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/scheduler/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /system/scheduler/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/scheduler/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/scheduler/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/scheduler/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /system/scheduler/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/scheduler/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/scheduler/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/scheduler/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/scheduler/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/scheduler/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/scheduler/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/scheduler/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/scheduler/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/scheduler/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /system/scheduler/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/system/scheduler/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/scheduler/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/scheduler/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/scheduler/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/scheduler/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /system/scheduler/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/scheduler/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/scheduler/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/scheduler/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/scheduler/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/scheduler/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/script get

GET: /system/script (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/script get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/script" \
	--user username:password

RESPONSE BODY

Type

array

/script put

PUT: /system/script (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/script put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/system/script" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /system/script/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /system/script/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/script/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/environment get

GET: /system/script/environment (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/environment get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/script/environment" \
	--user username:password

RESPONSE BODY

Type

array

/comment post

POST: /system/script/environment/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/environment/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/script/environment/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/environment/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/script/environment/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/environment/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/script/environment/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/environment/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/script/environment/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/script/environment/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /system/script/environment/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/system/script/environment/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/script/environment/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/script/environment/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/script/environment/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/environment/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /system/script/environment/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/environment/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/script/environment/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/environment/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/script/environment/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/environment/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/script/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/script/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/script/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/script/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/script/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /system/script/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/system/script/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/script/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/script/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/job get

GET: /system/script/job (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/job get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/script/job" \
	--user username:password

RESPONSE BODY

Type

array

/comment post

POST: /system/script/job/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/job/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/script/job/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/job/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/script/job/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/job/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/script/job/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/job/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/script/job/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/script/job/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /system/script/job/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/system/script/job/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/script/job/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/script/job/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/script/job/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/job/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /system/script/job/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/job/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/script/job/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/job/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/script/job/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/job/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/script/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /system/script/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/script/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/run post

POST: /system/script/run (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/run post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/run" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/script/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/script/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/serial-terminal post

POST: /system/serial-terminal (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/serial-terminal post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/serial-terminal" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/shutdown post

POST: /system/shutdown (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/shutdown post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/shutdown" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ssh post

POST: /system/ssh (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ssh post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ssh" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ssh-exec post

POST: /system/ssh-exec (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ssh-exec post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ssh-exec" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/sup-output post

POST: /system/sup-output (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sup-output post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/sup-output" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/telnet post

POST: /system/telnet (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/telnet post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/telnet" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/upgrade get

GET: /system/upgrade (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/upgrade get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/upgrade" \
	--user username:password

RESPONSE BODY

Type

array

/download post

POST: /system/upgrade/download (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/download post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/download" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/download-all post

POST: /system/upgrade/download-all (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/download-all post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/download-all" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/upgrade/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/upgrade/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/upgrade/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/upgrade/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/upgrade/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/upgrade/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/upgrade/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/upgrade/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/mirror get

GET: /system/upgrade/mirror (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mirror get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/upgrade/mirror" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /system/upgrade/mirror/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/mirror/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/upgrade/mirror/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/mirror/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/force-check post

POST: /system/upgrade/mirror/force-check (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/force-check post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/mirror/force-check" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/upgrade/mirror/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/mirror/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/upgrade/mirror/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/upgrade/mirror/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/upgrade/mirror/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/upgrade/mirror/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/upgrade/mirror/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/mirror/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/upgrade/mirror/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/mirror/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/upgrade/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/refresh post

POST: /system/upgrade/refresh (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/refresh post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/refresh" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/upgrade/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/upgrade/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/upgrade-package-source get

GET: /system/upgrade/upgrade-package-source (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/upgrade-package-source get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/upgrade/upgrade-package-source" \
	--user username:password

RESPONSE BODY

Type

array

/upgrade-package-source put

PUT: /system/upgrade/upgrade-package-source (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/upgrade-package-source put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/system/upgrade/upgrade-package-source" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /system/upgrade/upgrade-package-source/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/upgrade-package-source/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/upgrade/upgrade-package-source/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/upgrade-package-source/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/upgrade/upgrade-package-source/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/upgrade-package-source/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/upgrade/upgrade-package-source/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/upgrade-package-source/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/upgrade/upgrade-package-source/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/upgrade-package-source/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/upgrade/upgrade-package-source/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/upgrade/upgrade-package-source/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /system/upgrade/upgrade-package-source/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/system/upgrade/upgrade-package-source/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/upgrade/upgrade-package-source/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/upgrade/upgrade-package-source/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/upgrade/upgrade-package-source/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/upgrade-package-source/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /system/upgrade/upgrade-package-source/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/upgrade-package-source/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/upgrade/upgrade-package-source/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/upgrade-package-source/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/upgrade/upgrade-package-source/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/upgrade/upgrade-package-source/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ups get

GET: /system/ups (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ups get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/ups" \
	--user username:password

RESPONSE BODY

Type

array

/ups put

PUT: /system/ups (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ups put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/system/ups" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /system/ups/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/beep post

POST: /system/ups/beep (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/beep post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/beep" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /system/ups/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /system/ups/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /system/ups/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /system/ups/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/ups/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /system/ups/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/ups/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/ups/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/ups/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /system/ups/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/system/ups/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/ups/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/ups/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/monitor post

POST: /system/ups/monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/monitor post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/ups/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /system/ups/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /system/ups/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/rtc post

POST: /system/ups/rtc (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/rtc post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/rtc" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/self-test post

POST: /system/ups/self-test (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/self-test post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/self-test" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/ups/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/ups/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/watchdog get

GET: /system/watchdog (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/watchdog get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/watchdog" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /system/watchdog/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/watchdog/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/watchdog/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/watchdog/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /system/watchdog/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/watchdog/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /system/watchdog/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/system/watchdog/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /system/watchdog/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/system/watchdog/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /system/watchdog/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/watchdog/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /system/watchdog/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/watchdog/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /system/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/system/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/task

/task get

GET: /task (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/task get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/task" \
	--user username:password

RESPONSE BODY

Type

array

/task put

PUT: /task (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/task put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/task" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /task/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/task/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /task/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/task/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /task/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/task/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /task/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/task/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /task/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/task/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/next post

POST: /task/next (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/next post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/task/next" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /task/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/task/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /task/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/task/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/terminate post

POST: /task/terminate (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/terminate post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/task/terminate" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /task/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/task/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/terminal

/ask post

POST: /terminal/ask (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ask post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/terminal/ask" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/cuu post

POST: /terminal/cuu (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/cuu post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/terminal/cuu" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/el post

POST: /terminal/el (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/el post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/terminal/el" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/inkey post

POST: /terminal/inkey (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/inkey post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/terminal/inkey" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/style post

POST: /terminal/style (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/style post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/terminal/style" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/time

/time post

POST: /time (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/time post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/time" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/timestamp

/timestamp post

POST: /timestamp (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/timestamp post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/timestamp" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/toarray

/toarray post

POST: /toarray (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/toarray post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/toarray" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/tobool

/tobool post

POST: /tobool (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/tobool post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tobool" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/tocrlf

/tocrlf post

POST: /tocrlf (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/tocrlf post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tocrlf" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/toid

/toid post

POST: /toid (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/toid post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/toid" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/toip

/toip post

POST: /toip (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/toip post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/toip" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/toip6

/toip6 post

POST: /toip6 (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/toip6 post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/toip6" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/tolf

/tolf post

POST: /tolf (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/tolf post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tolf" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/tonsec

/tonsec post

POST: /tonsec (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/tonsec post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tonsec" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/tonum

/tonum post

POST: /tonum (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/tonum post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tonum" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/tool

/bandwidth-server get

GET: /tool/bandwidth-server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/bandwidth-server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/bandwidth-server" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /tool/bandwidth-server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/bandwidth-server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/bandwidth-server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/bandwidth-server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/bandwidth-server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/bandwidth-server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/bandwidth-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/bandwidth-server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/bandwidth-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/bandwidth-server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/bandwidth-server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/bandwidth-server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/session get

GET: /tool/bandwidth-server/session (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/session get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/bandwidth-server/session" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /tool/bandwidth-server/session/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/bandwidth-server/session/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/bandwidth-server/session/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/bandwidth-server/session/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/bandwidth-server/session/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/bandwidth-server/session/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /tool/bandwidth-server/session/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/tool/bandwidth-server/session/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/bandwidth-server/session/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/bandwidth-server/session/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /tool/bandwidth-server/session/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/bandwidth-server/session/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/bandwidth-server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/bandwidth-server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/bandwidth-test post

POST: /tool/bandwidth-test (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/bandwidth-test post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/bandwidth-test" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/dns-update post

POST: /tool/dns-update (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/dns-update post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/dns-update" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/e-mail get

GET: /tool/e-mail (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/e-mail get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/e-mail" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /tool/e-mail/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/e-mail/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/e-mail/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/e-mail/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/e-mail/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/e-mail/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/e-mail/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/e-mail/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/e-mail/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/e-mail/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/e-mail/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/e-mail/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/send post

POST: /tool/e-mail/send (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/send post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/e-mail/send" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/e-mail/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/e-mail/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/fetch post

POST: /tool/fetch (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/fetch post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/fetch" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/flood-ping post

POST: /tool/flood-ping (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/flood-ping post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/flood-ping" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/graphing get

GET: /tool/graphing (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/graphing get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/graphing" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /tool/graphing/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/graphing/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/graphing/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/graphing/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/graphing/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/graphing/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/graphing/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/interface get

GET: /tool/graphing/interface (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/graphing/interface" \
	--user username:password

RESPONSE BODY

Type

array

/interface put

PUT: /tool/graphing/interface (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/interface put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/tool/graphing/interface" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /tool/graphing/interface/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/interface/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /tool/graphing/interface/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/interface/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /tool/graphing/interface/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/interface/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /tool/graphing/interface/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/interface/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /tool/graphing/interface/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/interface/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/graphing/interface/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/interface/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /tool/graphing/interface/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/interface/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/graphing/interface/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/interface/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/graphing/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/graphing/interface/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /tool/graphing/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/tool/graphing/interface/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/graphing/interface/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/graphing/interface/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/graphing/interface/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/interface/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /tool/graphing/interface/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/interface/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /tool/graphing/interface/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/interface/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/graphing/interface/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/interface/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/graphing/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/queue get

GET: /tool/graphing/queue (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/queue get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/graphing/queue" \
	--user username:password

RESPONSE BODY

Type

array

/queue put

PUT: /tool/graphing/queue (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/queue put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/tool/graphing/queue" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /tool/graphing/queue/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/queue/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /tool/graphing/queue/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/queue/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /tool/graphing/queue/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/queue/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /tool/graphing/queue/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/queue/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /tool/graphing/queue/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/queue/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/graphing/queue/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/queue/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /tool/graphing/queue/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/queue/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/graphing/queue/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/queue/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/graphing/queue/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/graphing/queue/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /tool/graphing/queue/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/tool/graphing/queue/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/graphing/queue/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/graphing/queue/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/graphing/queue/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/queue/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /tool/graphing/queue/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/queue/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /tool/graphing/queue/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/queue/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/graphing/queue/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/queue/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/resource get

GET: /tool/graphing/resource (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/resource get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/graphing/resource" \
	--user username:password

RESPONSE BODY

Type

array

/resource put

PUT: /tool/graphing/resource (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/resource put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/tool/graphing/resource" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /tool/graphing/resource/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/resource/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /tool/graphing/resource/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/resource/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /tool/graphing/resource/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/resource/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /tool/graphing/resource/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/resource/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /tool/graphing/resource/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/resource/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/graphing/resource/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/resource/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /tool/graphing/resource/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/resource/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/graphing/resource/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/resource/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/graphing/resource/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/graphing/resource/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /tool/graphing/resource/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/tool/graphing/resource/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/graphing/resource/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/graphing/resource/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/graphing/resource/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/resource/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /tool/graphing/resource/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/resource/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /tool/graphing/resource/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/resource/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/graphing/resource/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/resource/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/graphing/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/graphing/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ip-scan post

POST: /tool/ip-scan (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ip-scan post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/ip-scan" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/mac-scan post

POST: /tool/mac-scan (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mac-scan post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-scan" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/mac-server get

GET: /tool/mac-server (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mac-server get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/mac-server" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /tool/mac-server/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/mac-server/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/mac-server/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/mac-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/mac-server/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/mac-server/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/mac-server/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/mac-winbox get

GET: /tool/mac-server/mac-winbox (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mac-winbox get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/mac-server/mac-winbox" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /tool/mac-server/mac-winbox/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/mac-winbox/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/mac-server/mac-winbox/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/mac-winbox/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/mac-server/mac-winbox/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/mac-winbox/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/mac-server/mac-winbox/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/mac-server/mac-winbox/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/mac-server/mac-winbox/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/mac-server/mac-winbox/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/mac-server/mac-winbox/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/mac-winbox/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/mac-server/mac-winbox/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/mac-winbox/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ping get

GET: /tool/mac-server/ping (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ping get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/mac-server/ping" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /tool/mac-server/ping/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/ping/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/mac-server/ping/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/ping/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/mac-server/ping/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/ping/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/mac-server/ping/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/mac-server/ping/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/mac-server/ping/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/mac-server/ping/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/mac-server/ping/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/ping/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/mac-server/ping/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/ping/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/mac-server/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/sessions get

GET: /tool/mac-server/sessions (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sessions get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/mac-server/sessions" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /tool/mac-server/sessions/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/sessions/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /tool/mac-server/sessions/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/sessions/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/mac-server/sessions/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/sessions/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/mac-server/sessions/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/mac-server/sessions/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/mac-server/sessions/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/mac-server/sessions/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/mac-server/sessions/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/sessions/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /tool/mac-server/sessions/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/sessions/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/mac-server/sessions/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/sessions/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/mac-server/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-server/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/mac-telnet post

POST: /tool/mac-telnet (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/mac-telnet post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/mac-telnet" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/netwatch get

GET: /tool/netwatch (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/netwatch get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/netwatch" \
	--user username:password

RESPONSE BODY

Type

array

/netwatch put

PUT: /tool/netwatch (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/netwatch put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/tool/netwatch" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /tool/netwatch/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/netwatch/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /tool/netwatch/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/netwatch/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /tool/netwatch/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/netwatch/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /tool/netwatch/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/netwatch/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /tool/netwatch/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/netwatch/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/netwatch/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/netwatch/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /tool/netwatch/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/netwatch/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/netwatch/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/netwatch/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/netwatch/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/netwatch/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /tool/netwatch/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/tool/netwatch/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/netwatch/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/netwatch/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/netwatch/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/netwatch/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /tool/netwatch/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/netwatch/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /tool/netwatch/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/netwatch/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/netwatch/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/netwatch/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /tool/netwatch/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/netwatch/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ping post

POST: /tool/ping (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ping post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/ping" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ping-speed post

POST: /tool/ping-speed (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ping-speed post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/ping-speed" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/profile post

POST: /tool/profile (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/profile post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/profile" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/romon get

GET: /tool/romon (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/romon get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/romon" \
	--user username:password

RESPONSE BODY

Type

array

/discover post

POST: /tool/romon/discover (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/discover post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/discover" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /tool/romon/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/romon/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/romon/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/romon/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/romon/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/romon/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/romon/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ping post

POST: /tool/romon/ping (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ping post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/ping" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/port get

GET: /tool/romon/port (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/port get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/romon/port" \
	--user username:password

RESPONSE BODY

Type

array

/port put

PUT: /tool/romon/port (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/port put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/tool/romon/port" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /tool/romon/port/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/port/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /tool/romon/port/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/port/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /tool/romon/port/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/port/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /tool/romon/port/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/port/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /tool/romon/port/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/port/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/romon/port/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/port/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /tool/romon/port/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/port/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/romon/port/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/port/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/romon/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/romon/port/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /tool/romon/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/tool/romon/port/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/romon/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/romon/port/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/romon/port/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/port/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /tool/romon/port/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/port/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /tool/romon/port/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/port/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/romon/port/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/port/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/romon/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/romon/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ssh post

POST: /tool/romon/ssh (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ssh post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/romon/ssh" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/sms get

GET: /tool/sms (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sms get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/sms" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /tool/sms/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sms/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/sms/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sms/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/sms/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sms/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/sms/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/sms/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/sms/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/sms/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/inbox get

GET: /tool/sms/inbox (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/inbox get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/sms/inbox" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /tool/sms/inbox/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sms/inbox/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/sms/inbox/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sms/inbox/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/sms/inbox/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/sms/inbox/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /tool/sms/inbox/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/tool/sms/inbox/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/sms/inbox/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sms/inbox/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /tool/sms/inbox/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sms/inbox/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/sms/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sms/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/send post

POST: /tool/sms/send (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/send post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sms/send" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/sms/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sms/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/sniffer get

GET: /tool/sniffer (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/sniffer get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/sniffer" \
	--user username:password

RESPONSE BODY

Type

array

/connection get

GET: /tool/sniffer/connection (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/connection get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/sniffer/connection" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /tool/sniffer/connection/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/connection/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/sniffer/connection/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/connection/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/sniffer/connection/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/sniffer/connection/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /tool/sniffer/connection/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/connection/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /tool/sniffer/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/sniffer/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/sniffer/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/sniffer/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/sniffer/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/sniffer/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/sniffer/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/host get

GET: /tool/sniffer/host (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/host get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/sniffer/host" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /tool/sniffer/host/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/host/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/sniffer/host/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/host/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/sniffer/host/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/sniffer/host/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /tool/sniffer/host/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/host/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/packet get

GET: /tool/sniffer/packet (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/packet get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/sniffer/packet" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /tool/sniffer/packet/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/packet/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/sniffer/packet/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/packet/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/sniffer/packet/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/sniffer/packet/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /tool/sniffer/packet/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/packet/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/sniffer/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/protocol get

GET: /tool/sniffer/protocol (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/protocol get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/sniffer/protocol" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /tool/sniffer/protocol/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/protocol/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/sniffer/protocol/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/protocol/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/sniffer/protocol/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/sniffer/protocol/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /tool/sniffer/protocol/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/protocol/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/quick post

POST: /tool/sniffer/quick (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/quick post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/quick" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/save post

POST: /tool/sniffer/save (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/save post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/save" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/sniffer/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/start post

POST: /tool/sniffer/start (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/start post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/start" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/stop post

POST: /tool/sniffer/stop (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/stop post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/sniffer/stop" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/snmp-get post

POST: /tool/snmp-get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/snmp-get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/snmp-get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/snmp-walk post

POST: /tool/snmp-walk (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/snmp-walk post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/snmp-walk" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/speed-test post

POST: /tool/speed-test (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/speed-test post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/speed-test" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/torch post

POST: /tool/torch (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/torch post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/torch" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/traceroute post

POST: /tool/traceroute (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/traceroute post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traceroute" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/traffic-generator get

GET: /tool/traffic-generator (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/traffic-generator get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /tool/traffic-generator/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/traffic-generator/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/traffic-generator/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/traffic-generator/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/traffic-generator/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/traffic-generator/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/inject post

POST: /tool/traffic-generator/inject (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/inject post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/inject" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/inject-pcap post

POST: /tool/traffic-generator/inject-pcap (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/inject-pcap post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/inject-pcap" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/packet-template get

GET: /tool/traffic-generator/packet-template (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/packet-template get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/packet-template" \
	--user username:password

RESPONSE BODY

Type

array

/packet-template put

PUT: /tool/traffic-generator/packet-template (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/packet-template put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/tool/traffic-generator/packet-template" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /tool/traffic-generator/packet-template/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/packet-template/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /tool/traffic-generator/packet-template/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/packet-template/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /tool/traffic-generator/packet-template/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/packet-template/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/traffic-generator/packet-template/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/packet-template/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /tool/traffic-generator/packet-template/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/packet-template/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/traffic-generator/packet-template/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/packet-template/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/traffic-generator/packet-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/packet-template/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /tool/traffic-generator/packet-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/tool/traffic-generator/packet-template/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/traffic-generator/packet-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/traffic-generator/packet-template/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/traffic-generator/packet-template/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/packet-template/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /tool/traffic-generator/packet-template/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/packet-template/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /tool/traffic-generator/packet-template/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/packet-template/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/traffic-generator/packet-template/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/packet-template/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /tool/traffic-generator/packet-template/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/packet-template/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/port get

GET: /tool/traffic-generator/port (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/port get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/port" \
	--user username:password

RESPONSE BODY

Type

array

/port put

PUT: /tool/traffic-generator/port (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/port put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/tool/traffic-generator/port" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /tool/traffic-generator/port/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/port/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /tool/traffic-generator/port/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/port/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /tool/traffic-generator/port/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/port/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /tool/traffic-generator/port/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/port/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/traffic-generator/port/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/port/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /tool/traffic-generator/port/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/port/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/traffic-generator/port/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/port/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/traffic-generator/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/port/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /tool/traffic-generator/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/tool/traffic-generator/port/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/traffic-generator/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/traffic-generator/port/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/traffic-generator/port/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/port/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /tool/traffic-generator/port/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/port/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /tool/traffic-generator/port/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/port/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/traffic-generator/port/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/port/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/traffic-generator/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/quick post

POST: /tool/traffic-generator/quick (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/quick post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/quick" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/raw-packet-template get

GET: /tool/traffic-generator/raw-packet-template (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/raw-packet-template get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template" \
	--user username:password

RESPONSE BODY

Type

array

/raw-packet-template put

PUT: /tool/traffic-generator/raw-packet-template (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/raw-packet-template put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /tool/traffic-generator/raw-packet-template/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /tool/traffic-generator/raw-packet-template/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /tool/traffic-generator/raw-packet-template/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/traffic-generator/raw-packet-template/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /tool/traffic-generator/raw-packet-template/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/traffic-generator/raw-packet-template/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/traffic-generator/raw-packet-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /tool/traffic-generator/raw-packet-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/traffic-generator/raw-packet-template/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/traffic-generator/raw-packet-template/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /tool/traffic-generator/raw-packet-template/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /tool/traffic-generator/raw-packet-template/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/traffic-generator/raw-packet-template/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /tool/traffic-generator/raw-packet-template/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/raw-packet-template/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/traffic-generator/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/start post

POST: /tool/traffic-generator/start (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/start post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/start" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/latency-distribution get

GET: /tool/traffic-generator/stats/latency-distribution (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/latency-distribution get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/stats/latency-distribution" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /tool/traffic-generator/stats/latency-distribution/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stats/latency-distribution/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/traffic-generator/stats/latency-distribution/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stats/latency-distribution/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/traffic-generator/stats/latency-distribution/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/stats/latency-distribution/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /tool/traffic-generator/stats/latency-distribution/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stats/latency-distribution/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/port get

GET: /tool/traffic-generator/stats/port (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/port get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/stats/port" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /tool/traffic-generator/stats/port/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stats/port/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/traffic-generator/stats/port/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stats/port/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/traffic-generator/stats/port/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/stats/port/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /tool/traffic-generator/stats/port/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stats/port/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/raw get

GET: /tool/traffic-generator/stats/raw (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/raw get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/stats/raw" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /tool/traffic-generator/stats/raw/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stats/raw/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/traffic-generator/stats/raw/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stats/raw/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/traffic-generator/stats/raw/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/stats/raw/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /tool/traffic-generator/stats/raw/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stats/raw/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/stream get

GET: /tool/traffic-generator/stats/stream (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/stream get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/stats/stream" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /tool/traffic-generator/stats/stream/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stats/stream/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/traffic-generator/stats/stream/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stats/stream/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/traffic-generator/stats/stream/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/stats/stream/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /tool/traffic-generator/stats/stream/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stats/stream/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/stop post

POST: /tool/traffic-generator/stop (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/stop post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stop" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/stream get

GET: /tool/traffic-generator/stream (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/stream get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/stream" \
	--user username:password

RESPONSE BODY

Type

array

/stream put

PUT: /tool/traffic-generator/stream (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/stream put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/tool/traffic-generator/stream" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /tool/traffic-generator/stream/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stream/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /tool/traffic-generator/stream/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stream/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /tool/traffic-generator/stream/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stream/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /tool/traffic-generator/stream/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stream/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/traffic-generator/stream/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stream/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /tool/traffic-generator/stream/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stream/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/traffic-generator/stream/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stream/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/traffic-generator/stream/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-generator/stream/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /tool/traffic-generator/stream/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/tool/traffic-generator/stream/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/traffic-generator/stream/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/traffic-generator/stream/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/traffic-generator/stream/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stream/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /tool/traffic-generator/stream/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stream/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /tool/traffic-generator/stream/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stream/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/traffic-generator/stream/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stream/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/unset post

POST: /tool/traffic-generator/stream/unset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-generator/stream/unset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/traffic-monitor get

GET: /tool/traffic-monitor (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/traffic-monitor get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-monitor" \
	--user username:password

RESPONSE BODY

Type

array

/traffic-monitor put

PUT: /tool/traffic-monitor (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/traffic-monitor put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/tool/traffic-monitor" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /tool/traffic-monitor/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-monitor/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /tool/traffic-monitor/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-monitor/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /tool/traffic-monitor/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-monitor/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /tool/traffic-monitor/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-monitor/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /tool/traffic-monitor/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-monitor/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/traffic-monitor/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-monitor/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /tool/traffic-monitor/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-monitor/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /tool/traffic-monitor/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-monitor/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /tool/traffic-monitor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/tool/traffic-monitor/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /tool/traffic-monitor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/tool/traffic-monitor/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /tool/traffic-monitor/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/tool/traffic-monitor/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /tool/traffic-monitor/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-monitor/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /tool/traffic-monitor/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-monitor/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /tool/traffic-monitor/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-monitor/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /tool/traffic-monitor/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/traffic-monitor/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/wol post

POST: /tool/wol (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/wol post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/wol" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /tool/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tool/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/tostr

/tostr post

POST: /tostr (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/tostr post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/tostr" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/totime

/totime post

POST: /totime (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/totime post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/totime" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/typeof

/typeof post

POST: /typeof (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/typeof post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/typeof" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/undo

/undo post

POST: /undo (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/undo post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/undo" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/user

/user get

GET: /user (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/user get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/user" \
	--user username:password

RESPONSE BODY

Type

array

/user put

PUT: /user (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/user put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/user" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/aaa get

GET: /user/aaa (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/aaa get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/user/aaa" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /user/aaa/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/aaa/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /user/aaa/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/aaa/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /user/aaa/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/aaa/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /user/aaa/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/user/aaa/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /user/aaa/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/user/aaa/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /user/aaa/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/aaa/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /user/aaa/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/aaa/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/active get

GET: /user/active (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/active get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/user/active" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /user/active/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/active/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /user/active/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/active/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /user/active/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/user/active/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /user/active/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/active/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/request-logout post

POST: /user/active/request-logout (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/request-logout post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/active/request-logout" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /user/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /user/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/disable post

POST: /user/disable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/disable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /user/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/enable post

POST: /user/enable (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/enable" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/expire-password post

POST: /user/expire-password (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/expire-password post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/expire-password" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /user/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /user/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /user/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/user/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /user/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/user/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /user/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/user/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/group get

GET: /user/group (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/group get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/user/group" \
	--user username:password

RESPONSE BODY

Type

array

/group put

PUT: /user/group (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/group put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/user/group" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /user/group/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/group/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/comment post

POST: /user/group/comment (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/group/comment" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/edit post

POST: /user/group/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/group/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /user/group/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/group/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /user/group/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/group/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /user/group/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/group/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /user/group/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/user/group/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /user/group/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/user/group/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /user/group/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/user/group/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /user/group/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/group/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /user/group/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/group/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /user/group/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/group/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /user/group/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/group/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /user/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /user/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /user/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /user/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/settings get

GET: /user/settings (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/settings get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/user/settings" \
	--user username:password

RESPONSE BODY

Type

array

/edit post

POST: /user/settings/edit (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/settings/edit" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /user/settings/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/settings/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /user/settings/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/settings/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /user/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/user/settings/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} patch

PATCH: /user/settings/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/user/settings/{id}" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /user/settings/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/settings/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/set post

POST: /user/settings/set (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/settings/set" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/ssh-keys get

GET: /user/ssh-keys (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ssh-keys get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/user/ssh-keys" \
	--user username:password

RESPONSE BODY

Type

array

/ssh-keys put

PUT: /user/ssh-keys (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/ssh-keys put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/user/ssh-keys" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/add post

POST: /user/ssh-keys/add (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/ssh-keys/add" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/find post

POST: /user/ssh-keys/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/ssh-keys/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /user/ssh-keys/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/ssh-keys/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /user/ssh-keys/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/user/ssh-keys/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /user/ssh-keys/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/user/ssh-keys/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/import post

POST: /user/ssh-keys/import (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/import post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/ssh-keys/import" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /user/ssh-keys/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/ssh-keys/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/private get

GET: /user/ssh-keys/private (secured)

Query Parameters

as-string

Property	Value
required	false
type	any

as-string-value

Property	Value
required	false
type	any

number

Property	Value
required	false
type	any

value-name

Property	Value
required	false
type	any

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/private get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/user/ssh-keys/private" \
	--user username:password

RESPONSE BODY

Type

array

/find post

POST: /user/ssh-keys/private/find (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/ssh-keys/private/find" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/get post

POST: /user/ssh-keys/private/get (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/ssh-keys/private/get" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/{id} get

GET: /user/ssh-keys/private/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/user/ssh-keys/private/{id}" \
	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /user/ssh-keys/private/{id} (secured)

URI Parameters

Property	Value
required	true
type	string

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/user/ssh-keys/private/{id}" \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/import post

POST: /user/ssh-keys/private/import (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/import post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/ssh-keys/private/import" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/print post

POST: /user/ssh-keys/private/print (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/ssh-keys/private/print" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /user/ssh-keys/private/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/ssh-keys/private/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /user/ssh-keys/private/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/ssh-keys/private/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/remove post

POST: /user/ssh-keys/remove (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/ssh-keys/remove" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/reset post

POST: /user/ssh-keys/reset (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/ssh-keys/reset" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export post

POST: /user/export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/user/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/while

/while post

POST: /while (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/while post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/while" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any

/export

/export post

POST: /export (secured)

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/export" \
	-d @request_body \
	--user username:password

REQUEST BODY

Type

object

RESPONSE BODY

Type: any