List applications
Get applications.
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 string required
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.
- 200
- 400
- 401
- 403
- 404
- default
List of applications
- application/json
- Schema
- Example (from schema)
Schema
data object[]
Array [able_to_transfer_file booleanalg_disable_capability stringPossible values:
<= 127 characters
category string requiredconsume_big_bandwidth booleandata_ident booleandefault object
- oneOf
- port
- ident_by_ip_protocol
- ident_by_icmp_type
- ident_by_icmp6_type
port string[]Possible values:
<= 63 characters
ident_by_ip_protocol stringident_by_icmp_type object
code stringtype string requiredident_by_icmp6_type object
code stringtype string requireddescription stringPossible values:
<= 1023 characters
evasive_behavior booleanfile_type_ident booleanhas_known_vulnerability booleanid stringuuid of the resource
name string requiredPossible values:
<= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
no_appid_caching booleanparent_app stringPossible values:
<= 127 characters
pervasive_use booleanprone_to_misuse booleanrisk integer requiredPossible values:
>= 1
and<= 5
signature object[]
Array [and_condition object[]
Array [name string requiredPossible values:
<= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
or_condition object[]
Array [name string requiredPossible values:
<= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
operator object required
- oneOf
- pattern_match
- greater_than
- less_than
- equal_to
pattern_match object
context string requiredPossible values:
<= 127 characters
pattern string requiredPossible values:
<= 127 characters
qualifier object[]
Array [name string requiredPossible values:
<= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
value string required]greater_than object
context string requiredPossible values:
<= 127 characters
qualifier object[]
Array [name string requiredPossible values:
<= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
value string required]value integer requiredPossible values:
<= 4294967295
less_than object
context string requiredPossible values:
<= 127 characters
qualifier object[]
Array [name string requiredPossible values:
<= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
value string required]value integer requiredPossible values:
<= 4294967295
equal_to object
context string requiredmask stringPossible values:
<= 10 characters
, Value must match regular expression^[0][xX][0-9A-Fa-f]{8}$
4-byte hex value
position stringPossible values:
<= 127 characters
value string requiredPossible values:
<= 10 characters
]]comment stringPossible values:
<= 256 characters
name string requiredPossible values:
<= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
order_free booleanDefault value:
false
scope stringPossible values: [
protocol-data-unit
,session
]Default value:
protocol-data-unit
]subcategory string requiredPossible values:
<= 63 characters
tcp_half_closed_timeout integerPossible values:
>= 1
and<= 604800
timeout for half-close session in seconds
tcp_time_wait_timeout integerPossible values:
>= 1
and<= 600
timeout for session in time_wait state in seconds
tcp_timeout integerPossible values:
<= 604800
timeout in seconds
technology string requiredPossible values:
<= 63 characters
timeout integerPossible values:
<= 604800
timeout in seconds
tunnel_applications booleantunnel_other_application booleanudp_timeout integerPossible values:
<= 604800
timeout in seconds
used_by_malware booleanvirus_ident boolean]- limit number
Default value:
200
- offset number
Default value:
0
- total number
{
"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
}
Bad Request
- application/json
- Schema
- Example (from schema)
- input_format_mismatch
- invalid_query_parameter
- missing_query_parameter
- output_format_mismatch
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Input Format Mismatch
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Input Format Mismatch: input-format=json"
}
],
"_request_id": "abcd-1234"
}
Invalid Query Parameter
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Invalid Query Parameter: location=invalid"
}
],
"_request_id": "abcd-1234"
}
Missing Query Parameter
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Missing Query Parameter: name"
}
],
"_request_id": "abcd-1234"
}
Output Format Mismatch
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Output Format Mismatch: output-format=json Accept=xml"
}
],
"_request_id": "abcd-1234"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- auth_not_authenticated
- invalid_credential
- key_expired
- key_too_long
- need_password_change
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Not Authenticated
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Not Authenticated"
}
],
"_request_id": "abcd-1234"
}
Invalid Credential
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Invalid Credential"
}
],
"_request_id": "abcd-1234"
}
Key Expired
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Key Expired"
}
],
"_request_id": "abcd-1234"
}
Key Too Long
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Key Too Long"
}
],
"_request_id": "abcd-1234"
}
Need Password Change
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "The password needs to be changed."
}
],
"_request_id": "abcd-1234"
}
Forbidden
- application/json
- Schema
- Example (from schema)
- auth_unauthorized
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Unauthorized
{
"_errors": [
{
"code": "E007",
"details": {},
"message": "Unauthorized"
}
],
"_request_id": "abcd-1234"
}
Not Found
- application/json
- Schema
- Example (from schema)
- object_not_present
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Object Not Present
{
"_errors": [
{
"code": "E005",
"details": {},
"message": "Object Not Present"
}
],
"_request_id": "abcd-1234"
}
General Errors
- application/json
- Schema
- Example (from schema)
- action_not_supported
- bad_xpath
- invalid_command
- malformed_command
- method_not_allowed
- session_timeout
- version_not_supported
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Action Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Action Not Supported: move"
}
],
"_request_id": "abcd-1234"
}
Bad XPath
{
"_errors": [
{
"code": "E013",
"details": {},
"message": "Bad XPath"
}
],
"_request_id": "abcd-1234"
}
Invalid Command
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Invalid Command"
}
],
"_request_id": "abcd-1234"
}
Malformed Command
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Malformed Command"
}
],
"_request_id": "abcd-1234"
}
Method Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Method Not Supported"
}
],
"_request_id": "abcd-1234"
}
Session Timeout
{
"_errors": [
{
"code": 4,
"details": {},
"message": "Session Timeout"
}
],
"_request_id": "abcd-1234"
}
Version Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Version Not Supported"
}
],
"_request_id": "abcd-1234"
}