Get existing session settings
GET/session-timeouts/: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_timeouts object
Possible values: >= 1
and <= 15999999
Default value: 30
Default timeout (seconds)
Possible values: >= 1
and <= 15999999
Default value: 60
Discard default (seconds)
Possible values: >= 1
and <= 15999999
Default value: 90
Discard TCP (seconds)
Possible values: >= 1
and <= 15999999
Default value: 60
Discard UDP (seconds)
Possible values: >= 1
and <= 15999999
Default value: 6
ICMP (seconds)
Possible values: >= 5
and <= 30
Default value: 10
Scan (seconds)
Possible values: >= 1
and <= 15999999
Default value: 3600
TCP (seconds)
Possible values: >= 1
and <= 60
Default value: 10
TCP handshake (seconds)
Possible values: >= 1
and <= 60
Default value: 5
TCP init (seconds)
Possible values: >= 1
and <= 604800
Default value: 120
TCP Half Closed (seconds)
Possible values: >= 1
and <= 600
Default value: 15
TCP Time Wait (seconds)
Possible values: >= 1
and <= 600
Default value: 30
Unverified RST (seconds)
Possible values: >= 1
and <= 15999999
Default value: 30
UDP (seconds)
Possible values: >= 1
and <= 15999999
Default value: 30
Captive Portal (seconds)
{
"id": "123e4567-e89b-12d3-a456-426655440000",
"session_timeouts": {
"timeout_default": 30,
"timeout_discard_default": 60,
"timeout_discard_tcp": 90,
"timeout_discard_udp": 60,
"timeout_icmp": 6,
"timeout_scan": 10,
"timeout_tcp": 3600,
"timeout_tcphandshake": 10,
"timeout_tcpinit": 5,
"timeout_tcp_half_closed": 120,
"timeout_tcp_time_wait": 15,
"timeout_tcp_unverified_rst": 30,
"timeout_udp": 30,
"timeout_captive_portal": 30
}
}
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"
}