List applications

GET 
/sse/config/v1/applications

Get applications.

Request

Query Parameters

limit number

The maximum number of result objects to return per page.

offset number

The offset of the result entry.

name string

The name of the entry.

folder stringrequired

Possible values: Value must match regular expression ^[0-9a-zA-Z._-\s]{1,}$, [Shared, Mobile Users, Remote Networks, Service Connections, Mobile Users Container, Mobile Users Explicit Proxy]

The folder on which you want to perform this operation.

Responses

200

List of applications

application/json

Schema

Schema

data object[]
Array [
able_to_transfer_file boolean
alg_disable_capability string
Possible values: <= 127 characters
category stringrequired
consume_big_bandwidth boolean
data_ident boolean
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
code string
type stringrequired
ident_by_icmp6_type
ident_by_icmp6_type object
code string
type stringrequired
description string
Possible values: <= 1023 characters
evasive_behavior boolean
file_type_ident boolean
has_known_vulnerability boolean
id string
uuid of the resource
name stringrequired
Possible values: <= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
no_appid_caching boolean
parent_app string
Possible values: <= 127 characters
pervasive_use boolean
prone_to_misuse boolean
risk integerrequired
Possible values: >= 1 and <= 5
signature object[]
Array [
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
qualifier object[]
Array [
name stringrequired
Possible values: <= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
value stringrequired
]
value integerrequired
Possible values: <= 4294967295
less_than
less_than object
context stringrequired
Possible values: <= 127 characters
qualifier object[]
Array [
name stringrequired
Possible values: <= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
value stringrequired
]
value integerrequired
Possible values: <= 4294967295
equal_to
equal_to object
context stringrequired
mask string
Possible values: <= 10 characters, Value must match regular expression ^[0][xX][0-9A-Fa-f]{8}$
4-byte hex value
position string
Possible values: <= 127 characters
value stringrequired
Possible values: <= 10 characters
]
]
comment string
Possible values: <= 256 characters
name stringrequired
Possible values: <= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
order_free boolean
scope string
Possible values: [protocol-data-unit, session]
Default value: protocol-data-unit
]
subcategory stringrequired
Possible values: <= 63 characters
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
tcp_timeout integer
Possible values: <= 604800
timeout in seconds
technology stringrequired
Possible values: <= 63 characters
timeout integer
Possible values: <= 604800
timeout in seconds
tunnel_applications boolean
tunnel_other_application boolean
udp_timeout integer
Possible values: <= 604800
timeout in seconds
used_by_malware boolean
virus_ident boolean
]
limit number

Default value: 200

offset number

Default value: 0

total number

Example (from schema)

{
  "data": [
    {
      "able_to_transfer_file": true,
      "alg_disable_capability": "string",
      "category": "string",
      "consume_big_bandwidth": true,
      "data_ident": true,
      "default": {
        "port": [
          "string"
        ]
      },
      "description": "string",
      "evasive_behavior": true,
      "file_type_ident": true,
      "has_known_vulnerability": true,
      "id": "abcd-1234",
      "name": "string",
      "no_appid_caching": true,
      "parent_app": "string",
      "pervasive_use": true,
      "prone_to_misuse": true,
      "risk": 0,
      "signature": [
        {
          "and_condition": [
            {
              "name": "string",
              "or_condition": [
                {
                  "name": "string",
                  "operator": {
                    "pattern_match": {
                      "context": "string",
                      "pattern": "string",
                      "qualifier": [
                        {
                          "name": "string",
                          "value": "string"
                        }
                      ]
                    }
                  }
                }
              ]
            }
          ],
          "comment": "string",
          "name": "string",
          "order_free": false,
          "scope": "protocol-data-unit"
        }
      ],
      "subcategory": "string",
      "tcp_half_closed_timeout": 0,
      "tcp_time_wait_timeout": 0,
      "tcp_timeout": 0,
      "technology": "string",
      "timeout": 0,
      "tunnel_applications": true,
      "tunnel_other_application": true,
      "udp_timeout": 0,
      "used_by_malware": true,
      "virus_ident": true
    }
  ],
  "limit": 200,
  "offset": 0,
  "total": 0
}

400

Bad Request

application/json

Schema

Schema

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

Example (from schema)

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

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Input Format Mismatch: input-format=json"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Invalid Query Parameter: location=invalid"
    }
  ],
  "_request_id": "abcd-1234"
}

missing_query_parameter

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Missing Query Parameter: name"
    }
  ],
  "_request_id": "abcd-1234"
}

output_format_mismatch

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Output Format Mismatch: output-format=json Accept=xml"
    }
  ],
  "_request_id": "abcd-1234"
}

401

Unauthorized

application/json

Schema

Schema

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

Example (from schema)

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

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Not Authenticated"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Invalid Credential"
    }
  ],
  "_request_id": "abcd-1234"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Key Expired"
    }
  ],
  "_request_id": "abcd-1234"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Key Too Long"
    }
  ],
  "_request_id": "abcd-1234"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "The password needs to be changed."
    }
  ],
  "_request_id": "abcd-1234"
}

403

Forbidden

application/json

Schema

Schema

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

Example (from schema)

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

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "details": {},
      "message": "Unauthorized"
    }
  ],
  "_request_id": "abcd-1234"
}

404

Not Found

application/json

Schema

Schema

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

Example (from schema)

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

object_not_present

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "details": {},
      "message": "Object Not Present"
    }
  ],
  "_request_id": "abcd-1234"
}

default

General Errors

application/json

Schema

Schema

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

Example (from schema)

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

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Action Not Supported: move"
    }
  ],
  "_request_id": "abcd-1234"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "details": {},
      "message": "Bad XPath"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Invalid Command"
    }
  ],
  "_request_id": "abcd-1234"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Malformed Command"
    }
  ],
  "_request_id": "abcd-1234"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Method Not Supported"
    }
  ],
  "_request_id": "abcd-1234"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": 4,
      "details": {},
      "message": "Session Timeout"
    }
  ],
  "_request_id": "abcd-1234"
}

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Version Not Supported"
    }
  ],
  "_request_id": "abcd-1234"
}

Loading...