Get the application by id

GET 
/applications/:id

Get an existing application.

Request

Path Parameters

id uuidrequired

The UUID of the configuration resource

Responses

200

OK

application/json

Schema

Schema

oneOf

folder

folder stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The folder in which the resource is defined

snippet

snippet stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The snippet in which the resource is defined

device

device stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The device in which the resource is defined

id stringrequired

The UUID of the application

name ^[ a-zA-Z\d._-]+$required

Possible values: <= 31 characters

The name of the application

default object
oneOf
port
port string[]
Possible values: <= 63 characters
ident_by_ip_protocol
ident_by_ip_protocol string
ident_by_icmp_type
ident_by_icmp_type object
type stringrequired
code string
ident_by_icmp6_type
ident_by_icmp6_type object
type stringrequired
code string
category stringrequired
subcategory stringrequired

Possible values: <= 63 characters

technology stringrequired

Possible values: <= 63 characters

description string

Possible values: <= 1023 characters

timeout integer

Possible values: <= 604800

timeout in seconds

tcp_timeout integer

Possible values: <= 604800

timeout in seconds

udp_timeout integer

Possible values: <= 604800

timeout in seconds

tcp_half_closed_timeout integer

Possible values: >= 1 and <= 604800

timeout for half-close session in seconds

tcp_time_wait_timeout integer

Possible values: >= 1 and <= 600

timeout for session in time_wait state in seconds

risk integerrequired

Possible values: >= 1 and <= 5

evasive_behavior boolean
consume_big_bandwidth boolean
used_by_malware boolean
able_to_transfer_file boolean
has_known_vulnerability boolean
tunnel_other_application boolean
tunnel_applications boolean
prone_to_misuse boolean
pervasive_use boolean
file_type_ident boolean
virus_ident boolean
data_ident boolean
no_appid_caching boolean
alg_disable_capability string

Possible values: <= 127 characters

parent_app string

Possible values: <= 127 characters

signature object[]
Array [
name stringrequired
Possible values: <= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
comment string
Possible values: <= 256 characters
scope
Possible values: [protocol-data-unit, session]
Default value: protocol-data-unit
order_free boolean
and_condition object[]
Array [
name stringrequired
Possible values: <= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
or_condition object[]
Array [
name stringrequired
Possible values: <= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
operator object required
oneOf
pattern_match
pattern_match object
context stringrequired
Possible values: <= 127 characters
pattern stringrequired
Possible values: <= 127 characters
qualifier object[]
Array [
name stringrequired
Possible values: <= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
value stringrequired
]
greater_than
greater_than object
context stringrequired
Possible values: <= 127 characters
value integerrequired
Possible values: <= 4294967295
qualifier object[]
Array [
name stringrequired
Possible values: <= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
value stringrequired
]
less_than
less_than object
context stringrequired
Possible values: <= 127 characters
value integerrequired
Possible values: <= 4294967295
qualifier object[]
Array [
name stringrequired
Possible values: <= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
value stringrequired
]
equal_to
equal_to object
context stringrequired
position string
Possible values: <= 127 characters
mask string
Possible values: <= 10 characters, Value must match regular expression ^[0][xX][0-9A-Fa-f]{8}$
4-byte hex value
value stringrequired
Possible values: <= 10 characters
]
]
]

Example (from schema)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "string",
  "default": {},
  "category": "string",
  "subcategory": "string",
  "technology": "string",
  "description": "string",
  "timeout": 0,
  "tcp_timeout": 0,
  "udp_timeout": 0,
  "tcp_half_closed_timeout": 0,
  "tcp_time_wait_timeout": 0,
  "risk": 0,
  "evasive_behavior": true,
  "consume_big_bandwidth": true,
  "used_by_malware": true,
  "able_to_transfer_file": true,
  "has_known_vulnerability": true,
  "tunnel_other_application": true,
  "tunnel_applications": true,
  "prone_to_misuse": true,
  "pervasive_use": true,
  "file_type_ident": true,
  "virus_ident": true,
  "data_ident": true,
  "no_appid_caching": true,
  "alg_disable_capability": "string",
  "parent_app": "string",
  "signature": [
    {
      "name": "string",
      "comment": "string",
      "order_free": false,
      "and_condition": [
        {
          "name": "string",
          "or_condition": [
            {
              "name": "string",
              "operator": {}
            }
          ]
        }
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Input Format Mismatch: input-format=json",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

output_format_mismatch

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Output Format Mismatch: output-format=json Accept=xml",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

missing_query_parameter

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Missing Query Parameter: name",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Query Parameter: location=invalid",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

401

Unauthorized

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "message": "Not Authenticated",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "message": "Invalid Credential",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Too Long",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Expired",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "message": "The password needs to be changed.",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

403

Forbidden

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "message": "Unauthorized",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

404

Not Found

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

object_not_present

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "message": "Object Not Present",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

default

General Errors

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Version Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Method Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Action Not Supported: move",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "message": "Bad XPath",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Malformed Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": "4",
      "message": "Session Timeout",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Loading...