Get existing session settings
GET/session-settings/:id
Retrieve existing session settings.
Request
Path Parameters
The UUID of the configuration resource
Responses
- 200
- 400
- 401
- 403
- 404
- default
OK
- application/json
- Schema
- Example (from schema)
Schema
- folder
- snippet
- device
Possible values: <= 64 characters
, Value must match regular expression ^[a-zA-Z\d-_\. ]+$
The folder in which the resource is defined
Possible values: <= 64 characters
, Value must match regular expression ^[a-zA-Z\d-_\. ]+$
The snippet in which the resource is defined
Possible values: <= 64 characters
, Value must match regular expression ^[a-zA-Z\d-_\. ]+$
The device in which the resource is defined
UUID of the resource
session_settings object
config object
Rematch all sessions on config policy change
icmpv6_rate_limit object
ICMPv6 rate limiting
Possible values: >= 10
and <= 65535
Default value: 100
ICMPv6 token bucket size
Possible values: >= 1
and <= 65535
Default value: 100
ICMPv6 error packet pate (per second)
Default value: true
Enable IPv6 firewalling
Enable ERSPAN support
jumbo_frame object
Enable jumbo frame support
Possible values: >= 512
and <= 9216
Default value: 9192
Global MTU
Enable DHCP broadcast session
nat64 object
Possible values: >= 1280
and <= 9216
Default value: 1280
NAT64 IPv6 minimum network MTU
nat object
Possible values: [1x
, 2x
, 4x
, 8x
]
Default value: 1x
NAT oversubscription rate
Possible values: >= 1
and <= 65535
Default value: 200
ICMP unreachable packet rate (per second)
Default value: true
Enable accelerated aging
Possible values: >= 50
and <= 99
Default value: 80
Accelerated aging threshold
Possible values: >= 2
and <= 16
Default value: 2
Accelerated aging scaling factor
Default value: true
Enable packet buffer protection
Packet buffer protection monitor only
Possible values: <= 99
Default value: 50
Alert (%)
Possible values: <= 99
Default value: 80
Activate (%)
Possible values: <= 99
Default value: 80
Block countdown threshold (%)
Possible values: <= 65535
Default value: 60
Block hold time (seconds)
Possible values: >= 1
and <= 15999999
Default value: 3600
Block duration (seconds)
Enabled latency-based activation
Possible values: >= 1
and <= 20000
Default value: 50
Latency alert (milliseconds)
Possible values: >= 1
and <= 20000
Default value: 200
Latency activate (milliseconds)
Possible values: >= 1
and <= 20000
Default value: 500
Latency max tolerate (milliseconds)
Possible values: >= 1
and <= 20000
Default value: 500
Block countdown threshold (milliseconds)
Multicast route setup buffering
Possible values: >= 1
and <= 2000
Default value: 1000
Multicast route setup buffer size
{
"id": "123e4567-e89b-12d3-a456-426655440000",
"session_settings": {
"config": {
"rematch": false
},
"icmpv6_rate_limit": {
"bucket_size": 100,
"packet_rate": 100
},
"ipv6_firewalling": true,
"erspan": false,
"jumbo_frame": {
"mtu": 9192
},
"dhcp_bcast_session_on": false,
"nat64": {
"ipv6_min_network_mtu": 1280
},
"nat": {
"dipp_oversub": "1x"
},
"icmp_unreachable_rate": 200,
"accelerated_aging_enable": true,
"accelerated_aging_threshold": 80,
"accelerated_aging_scaling_factor": 2,
"packet_buffer_protection_enable": true,
"packet_buffer_protection_monitor_only": false,
"packet_buffer_protection_alert": 50,
"packet_buffer_protection_activate": 80,
"packet_buffer_protection_block_countdown": 80,
"packet_buffer_protection_block_hold_time": 60,
"packet_buffer_protection_block_duration_time": 3600,
"packet_buffer_protection_use_latency": false,
"packet_buffer_protection_latency_alert": 50,
"packet_buffer_protection_latency_activate": 200,
"packet_buffer_protection_latency_max_tolerate": 500,
"packet_buffer_protection_latency_block_countdown": 500,
"multicast_route_setup_buffering": false,
"max_pending_mcast_pkts_per_session": 1000
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
- input_format_mismatch
- output_format_mismatch
- missing_query_parameter
- invalid_query_parameter
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_errors": [
{
"code": "E003",
"message": "Input Format Mismatch: input-format=json",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Output Format Mismatch: output-format=json Accept=xml",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Missing Query Parameter: name",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Invalid Query Parameter: location=invalid",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- auth_not_authenticated
- invalid_credential
- key_too_long
- key_expired
- need_password_change
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_errors": [
{
"code": "E016",
"message": "Not Authenticated",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E016",
"message": "Invalid Credential",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E016",
"message": "Key Too Long",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E016",
"message": "Key Expired",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E016",
"message": "The password needs to be changed.",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Forbidden
- application/json
- Schema
- Example (from schema)
- auth_unauthorized
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_errors": [
{
"code": "E007",
"message": "Unauthorized",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Not Found
- application/json
- Schema
- Example (from schema)
- object_not_present
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_errors": [
{
"code": "E005",
"message": "Object Not Present",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
General Errors
- application/json
- Schema
- Example (from schema)
- version_not_supported
- method_not_allowed
- action_not_supported
- bad_xpath
- invalid_command
- malformed_command
- session_timeout
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_errors": [
{
"code": "E012",
"message": "Version Not Supported",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E012",
"message": "Method Not Supported",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E012",
"message": "Action Not Supported: move",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E013",
"message": "Bad XPath",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Invalid Command",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Malformed Command",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "4",
"message": "Session Timeout",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}