FortiOS v6.4.14 cmdb system

GET /system.3g-modem/custom

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.3g-modem/custom

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.3g-modem/custom/{id}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.3g-modem/custom/{id}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.3g-modem/custom/{id}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.autoupdate/push-update

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.autoupdate/push-update

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.autoupdate/schedule

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.autoupdate/schedule

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.autoupdate/tunneling

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.autoupdate/tunneling

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.dhcp/server

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.dhcp/server

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.dhcp/server/{id}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.dhcp/server/{id}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.dhcp/server/{id}

Update this specific resource. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.dhcp6/server

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.dhcp6/server

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.dhcp6/server/{id}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.dhcp6/server/{id}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.dhcp6/server/{id}

Update this specific resource. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.lldp/network-policy

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.lldp/network-policy

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.lldp/network-policy/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.lldp/network-policy/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.lldp/network-policy/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/admin

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.replacemsg/admin

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.replacemsg/admin/{msg-type}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/admin/{msg-type}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.replacemsg/admin/{msg-type}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/alertmail

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.replacemsg/alertmail

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.replacemsg/alertmail/{msg-type}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/alertmail/{msg-type}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.replacemsg/alertmail/{msg-type}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/auth

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.replacemsg/auth

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.replacemsg/auth/{msg-type}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/auth/{msg-type}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.replacemsg/auth/{msg-type}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/fortiguard-wf

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.replacemsg/fortiguard-wf

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.replacemsg/fortiguard-wf/{msg-type}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/fortiguard-wf/{msg-type}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.replacemsg/fortiguard-wf/{msg-type}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/ftp

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.replacemsg/ftp

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.replacemsg/ftp/{msg-type}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/ftp/{msg-type}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.replacemsg/ftp/{msg-type}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/http

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.replacemsg/http

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.replacemsg/http/{msg-type}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/http/{msg-type}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.replacemsg/http/{msg-type}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/icap

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.replacemsg/icap

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.replacemsg/icap/{msg-type}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/icap/{msg-type}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.replacemsg/icap/{msg-type}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/mail

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.replacemsg/mail

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.replacemsg/mail/{msg-type}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/mail/{msg-type}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.replacemsg/mail/{msg-type}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/nac-quar

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.replacemsg/nac-quar

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.replacemsg/nac-quar/{msg-type}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/nac-quar/{msg-type}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.replacemsg/nac-quar/{msg-type}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/spam

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.replacemsg/spam

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.replacemsg/spam/{msg-type}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/spam/{msg-type}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.replacemsg/spam/{msg-type}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/sslvpn

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.replacemsg/sslvpn

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.replacemsg/sslvpn/{msg-type}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/sslvpn/{msg-type}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.replacemsg/sslvpn/{msg-type}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/traffic-quota

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.replacemsg/traffic-quota

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.replacemsg/traffic-quota/{msg-type}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/traffic-quota/{msg-type}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.replacemsg/traffic-quota/{msg-type}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/utm

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.replacemsg/utm

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.replacemsg/utm/{msg-type}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/utm/{msg-type}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.replacemsg/utm/{msg-type}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/webproxy

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.replacemsg/webproxy

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.replacemsg/webproxy/{msg-type}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.replacemsg/webproxy/{msg-type}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.replacemsg/webproxy/{msg-type}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

msg-type (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.snmp/community

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.snmp/community

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.snmp/community/{id}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.snmp/community/{id}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.snmp/community/{id}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.snmp/sysinfo

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.snmp/sysinfo

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.snmp/user

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system.snmp/user

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system.snmp/user/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system.snmp/user/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system.snmp/user/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/accprofile

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/accprofile

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/accprofile/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/accprofile/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/accprofile/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/admin

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/admin

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/admin/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/admin/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/admin/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/alarm

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/alarm

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/api-user

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/api-user

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/api-user/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/api-user/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/api-user/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/arp-table

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/arp-table

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/arp-table/{id}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/arp-table/{id}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/arp-table/{id}

Update this specific resource. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/auto-install

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/auto-install

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/auto-script

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/auto-script

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/auto-script/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/auto-script/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/auto-script/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/automation-action

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/automation-action

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/automation-action/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/automation-action/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/automation-action/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/automation-destination

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/automation-destination

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/automation-destination/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/automation-destination/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/automation-destination/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/automation-stitch

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/automation-stitch

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/automation-stitch/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/automation-stitch/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/automation-stitch/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/automation-trigger

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/automation-trigger

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/automation-trigger/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/automation-trigger/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/automation-trigger/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/central-management

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/central-management

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/cluster-sync

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/cluster-sync

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/cluster-sync/{sync-id}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

sync-id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/cluster-sync/{sync-id}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

sync-id (integer) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/cluster-sync/{sync-id}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

sync-id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/console

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/console

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/csf

Select all entries in a CLI table. ** Access Group: secfabgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/csf

Update this specific resource. ** Access Group: secfabgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/custom-language

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/custom-language

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/custom-language/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/custom-language/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/custom-language/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ddns

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/ddns

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/ddns/{ddnsid}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

ddnsid (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ddns/{ddnsid}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

ddnsid (integer) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/ddns/{ddnsid}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

ddnsid (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/dedicated-mgmt

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/dedicated-mgmt

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/dns

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/dns

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/dns-database

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/dns-database

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/dns-database/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/dns-database/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/dns-database/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/dns-server

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/dns-server

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/dns-server/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/dns-server/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/dns-server/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/dscp-based-priority

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/dscp-based-priority

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/dscp-based-priority/{id}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/dscp-based-priority/{id}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/dscp-based-priority/{id}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/email-server

Select all entries in a CLI table. ** Access Group: loggrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/email-server

Update this specific resource. ** Access Group: loggrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/external-resource

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/external-resource

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/external-resource/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/external-resource/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/external-resource/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/fips-cc

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/fips-cc

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/fortiguard

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/fortiguard

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/fortimanager

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/fortimanager

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/fortisandbox

Select all entries in a CLI table. ** Access Group: secfabgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/fortisandbox

Update this specific resource. ** Access Group: secfabgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/fsso-polling

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/fsso-polling

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ftm-push

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/ftm-push

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/geneve

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/geneve

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/geneve/{name}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/geneve/{name}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/geneve/{name}

Update this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/geoip-country

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/geoip-country

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/geoip-country/{id}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

id (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/geoip-country/{id}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

id (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/geoip-country/{id}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

id (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/geoip-override

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/geoip-override

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/geoip-override/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/geoip-override/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/geoip-override/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/global

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/global

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/gre-tunnel

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/gre-tunnel

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/gre-tunnel/{name}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/gre-tunnel/{name}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/gre-tunnel/{name}

Update this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ha

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/ha

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ha-monitor

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/ha-monitor

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/interface

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/interface

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/interface/{name}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/interface/{name}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/interface/{name}

Update this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ipip-tunnel

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/ipip-tunnel

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/ipip-tunnel/{name}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ipip-tunnel/{name}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/ipip-tunnel/{name}

Update this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ips

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/ips

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ips-urlfilter-dns

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/ips-urlfilter-dns

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/ips-urlfilter-dns/{address}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

address (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ips-urlfilter-dns/{address}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

address (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/ips-urlfilter-dns/{address}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

address (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ips-urlfilter-dns6

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/ips-urlfilter-dns6

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/ips-urlfilter-dns6/{address6}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

address6 (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ips-urlfilter-dns6/{address6}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

address6 (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/ips-urlfilter-dns6/{address6}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

address6 (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ipsec-aggregate

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/ipsec-aggregate

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/ipsec-aggregate/{name}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ipsec-aggregate/{name}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/ipsec-aggregate/{name}

Update this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ipv6-neighbor-cache

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/ipv6-neighbor-cache

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/ipv6-neighbor-cache/{id}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ipv6-neighbor-cache/{id}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/ipv6-neighbor-cache/{id}

Update this specific resource. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ipv6-tunnel

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/ipv6-tunnel

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/ipv6-tunnel/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ipv6-tunnel/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/ipv6-tunnel/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/link-monitor

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/link-monitor

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/link-monitor/{name}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/link-monitor/{name}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/link-monitor/{name}

Update this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/lte-modem

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/lte-modem

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/mac-address-table

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/mac-address-table

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/mac-address-table/{mac}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

mac (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/mac-address-table/{mac}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

mac (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/mac-address-table/{mac}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

mac (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/mobile-tunnel

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/mobile-tunnel

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/mobile-tunnel/{name}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/mobile-tunnel/{name}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/mobile-tunnel/{name}

Update this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/modem

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/modem

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/nat64

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/nat64

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/nd-proxy

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/nd-proxy

Update this specific resource. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/netflow

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/netflow

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/network-visibility

Select all entries in a CLI table. ** Access Group: loggrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/network-visibility

Update this specific resource. ** Access Group: loggrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/npu

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/npu

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ntp

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/ntp

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/object-tagging

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/object-tagging

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/object-tagging/{category}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

category (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/object-tagging/{category}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

category (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/object-tagging/{category}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

category (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/password-policy

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/password-policy

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/password-policy-guest-admin

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/password-policy-guest-admin

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/physical-switch

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/physical-switch

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/physical-switch/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/physical-switch/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/physical-switch/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/pppoe-interface

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/pppoe-interface

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/pppoe-interface/{name}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/pppoe-interface/{name}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/pppoe-interface/{name}

Update this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/probe-response

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/probe-response

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/proxy-arp

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/proxy-arp

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/proxy-arp/{id}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/proxy-arp/{id}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/proxy-arp/{id}

Update this specific resource. ** Access Group: netgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/ptp

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/ptp

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/replacemsg-group

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/replacemsg-group

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/replacemsg-group/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/replacemsg-group/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/replacemsg-group/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/replacemsg-image

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/replacemsg-image

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/replacemsg-image/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/replacemsg-image/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/replacemsg-image/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/resource-limits

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/resource-limits

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/saml

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/saml

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/sdn-connector

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/sdn-connector

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/sdn-connector/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/sdn-connector/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/sdn-connector/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/sdwan

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/sdwan

Update this specific resource. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/session-helper

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/session-helper

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/session-helper/{id}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/session-helper/{id}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/session-helper/{id}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/session-ttl

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/session-ttl

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/settings

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/settings

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/sflow

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/sflow

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/sit-tunnel

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/sit-tunnel

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/sit-tunnel/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/sit-tunnel/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/sit-tunnel/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/sms-server

Select all entries in a CLI table. ** Access Group: authgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/sms-server

Create object(s) in this table. ** Access Group: authgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/sms-server/{name}

Delete this specific resource. ** Access Group: authgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/sms-server/{name}

Select a specific entry from a CLI table. ** Access Group: authgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/sms-server/{name}

Update this specific resource. ** Access Group: authgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/speed-test-server

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/speed-test-server

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/speed-test-server/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/speed-test-server/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/speed-test-server/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/sso-admin

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/sso-admin

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/sso-admin/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/sso-admin/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/sso-admin/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/standalone-cluster

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/standalone-cluster

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/storage

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/storage

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/storage/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/storage/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/storage/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/stp

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/stp

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/switch-interface

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/switch-interface

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/switch-interface/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/switch-interface/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/switch-interface/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/tos-based-priority

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/tos-based-priority

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/tos-based-priority/{id}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/tos-based-priority/{id}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/tos-based-priority/{id}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vdom

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/vdom

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vdom-dns

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/vdom-dns

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vdom-exception

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/vdom-exception

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/vdom-exception/{id}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vdom-exception/{id}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/vdom-exception/{id}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

id (integer) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vdom-link

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/vdom-link

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/vdom-link/{name}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vdom-link/{name}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/vdom-link/{name}

Update this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vdom-netflow

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/vdom-netflow

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vdom-property

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/vdom-property

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/vdom-property/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vdom-property/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/vdom-property/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vdom-radius-server

Select all entries in a CLI table. ** Access Group: authgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/vdom-radius-server

Create object(s) in this table. ** Access Group: authgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/vdom-radius-server/{name}

Delete this specific resource. ** Access Group: authgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vdom-radius-server/{name}

Select a specific entry from a CLI table. ** Access Group: authgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/vdom-radius-server/{name}

Update this specific resource. ** Access Group: authgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vdom-sflow

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/vdom-sflow

Update this specific resource. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/vdom/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vdom/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/vdom/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/virtual-switch

Select all entries in a CLI table. ** Access Group: sysgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/virtual-switch

Create object(s) in this table. ** Access Group: sysgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/virtual-switch/{name}

Delete this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/virtual-switch/{name}

Select a specific entry from a CLI table. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/virtual-switch/{name}

Update this specific resource. ** Access Group: sysgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/virtual-wire-pair

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/virtual-wire-pair

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/virtual-wire-pair/{name}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/virtual-wire-pair/{name}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/virtual-wire-pair/{name}

Update this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vne-tunnel

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/vne-tunnel

Update this specific resource. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vxlan

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/vxlan

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/vxlan/{name}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/vxlan/{name}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/vxlan/{name}

Update this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/wccp

Select all entries in a CLI table. ** Access Group: secfabgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/wccp

Create object(s) in this table. ** Access Group: secfabgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/wccp/{service-id}

Delete this specific resource. ** Access Group: secfabgrp**

Parameters:

service-id (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/wccp/{service-id}

Select a specific entry from a CLI table. ** Access Group: secfabgrp**

Parameters:

service-id (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/wccp/{service-id}

Update this specific resource. ** Access Group: secfabgrp**

Parameters:

service-id (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/zone

Select all entries in a CLI table. ** Access Group: netgrp**

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
start (integer) – Starting entry index.
count (integer) – Maximum number of entries to return.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
with_contents_hash (boolean) – Enable to include a checksum of each object’s contents.
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
filter (array) – Filtering multiple key/value pairs Operator | Description == | Case insensitive match with pattern. != | Does not match with pattern (case insensitive). =@ | Pattern found in object value (case insensitive). !@ | Pattern not found in object value (case insensitive). <= | Value must be less than or equal to pattern. < | Value must be less than pattern. .>= | Value must be greater than or equal to pattern. .> | Value must be greater than pattern. Logical OR | Separate filters using commas ‘,’ Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. Combining AND and OR | You can combine AND and OR filters together to create more complex filters.
key (string) – If present, objects will be filtered on property with this name.
pattern (string) – If present, objects will be filtered on property with this value.
scope (string) – Scope [global|vdom|both*]
exclude-default-values (boolean) – Exclude properties/objects with default value
action (string) – default: Return the CLI default values for entire CLI tree. meta: Return meta data for a specific object, table, or the entire CLI tree. schema: Return schema for entire CLI tree.
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

POST /system/zone

Create object(s) in this table. ** Access Group: netgrp**

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _clone_: Clone this specific resource. When action=clone is set, the extra parameters nkey must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
nkey (string) –

If action=clone, use nkey to specify the ID for the new resource to be created.

For example, to clone address1 to address1_clone, use: __action=clone&nkey=address1_clone__ __*Note:__ This parameter can only be used when the *action parameter is set to clone.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

DELETE /system/zone/{name}

Delete this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

GET /system/zone/{name}

Select a specific entry from a CLI table. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

datasource (boolean) – Enable to include datasource information for each linked object.
with_meta (boolean) – Enable to include meta information about each object (type id, references, etc).
skip (boolean) – Enable to call CLI skip operator to hide skipped properties.
format (array) – List of property names to include in results, separated by | (i.e. policyid|srcintf).
action (string) – default: Return the CLI default values for this object type. schema: Return the CLI schema for this object type. revision: Return the CMDB revision for this object type. transaction-list: List all configuration transaction(s).
vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request

PUT /system/zone/{name}

Update this specific resource. ** Access Group: netgrp**

Parameters:

name (string) – mkey

Query Parameters:

vdom (array) – Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)
action (string) – If supported, an action can be specified. _move_: Move this specific resource. When action=move is set, one of the extra parameters (before, after) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.
before (string) – If action=move, use before to specify the ID of the resource that this resource will be moved before. For example, to move object 1 to before object 2, use: __action=move&before=2__ __*Note:__ This parameter can only be used when the *action parameter is set to move.
after (string) – If action=move, use after to specify the ID of the resource that this resource will be moved after. For example, to move object 1 to after object 3, use: __action=move&after=3__ __*Note:__ This parameter can only be used when the *action parameter is set to move.

Status Codes:

200 OK – OK: Request returns successful
400 Bad Request – Bad Request: Request cannot be processed by the API
401 Unauthorized – Not Authorized: Request without successful login session
403 Forbidden – Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 Not Found – Resource Not Found: Unable to find the specified resource.
405 Method Not Allowed – Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 Request Entity Too Large – Request Entity Too Large: Request cannot be processed due to large entity
424 Failed Dependency – Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
429 Too Many Requests – Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 Internal Server Error – Internal Server Error: Internal error when processing the request