Get an external dynamic list

Get an external dynamic list by ID.

Path Parameters

id string required
The resource's unique identifier.

Responses

Get security rule by id

application/json

Schema
Example (from schema)

Schema

Array [
id string
uuid of the resource
name string required
Possible values: <= 63 characters
Alphanumeric string [ 0-9a-zA-Z._-]
type object required
oneOf
predefined_ip
predefined_url
ip
domain
url
imsi
imei
predefined_ip object
description string
Possible values: <= 255 characters
exception_list string[]
Possible values: <= 255 characters
url string required
predefined_url object
description string
Possible values: <= 255 characters
exception_list string[]
Possible values: <= 255 characters
url string required
ip object
auth object
password string required
Possible values: <= 255 characters
username string required
Possible values: non-empty and <= 255 characters
certificate_profile string
Default value: None
Profile for authenticating client certificates
description string
Possible values: <= 255 characters
exception_list string[]
Possible values: <= 255 characters
recurring object required
oneOf
five_minute
hourly
daily
weekly
monthly
five_minute object required
url string required
Possible values: <= 255 characters
Default value: http://

domain object

auth object

password string required

Possible values: <= 255 characters

username string required

Possible values: non-empty and <= 255 characters

certificate_profile string

Default value: None

Profile for authenticating client certificates

description string

Possible values: <= 255 characters

exception_list string[]

Possible values: <= 255 characters

expand_domain boolean

Default value: false

Enable/Disable expand domain

recurring object required

oneOf

hourly
five_minute
daily
weekly
monthly

hourly object required

daily object required

at string required

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ([01][0-9]|[2][0-3])

Default value: 00

Time specification hh (e.g. 20)

weekly object required

at string required

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ([01][0-9]|[2][0-3])

Default value: 00

Time specification hh (e.g. 20)

day_of_week string required

Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]

monthly object required

at string required

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ([01][0-9]|[2][0-3])

Default value: 00

Time specification hh (e.g. 20)

day_of_month integer required

Possible values: >= 1 and <= 31

url string required

Possible values: <= 255 characters

Default value: http://

url object

auth object

password string required

Possible values: <= 255 characters

username string required

Possible values: non-empty and <= 255 characters

certificate_profile string

Default value: None

Profile for authenticating client certificates

description string

Possible values: <= 255 characters

exception_list string[]

Possible values: <= 255 characters

recurring object required

oneOf

hourly
five_minute
daily
weekly
monthly

hourly object required

daily object required

at string required

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ([01][0-9]|[2][0-3])

Default value: 00

Time specification hh (e.g. 20)

weekly object required

at string required

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ([01][0-9]|[2][0-3])

Default value: 00

Time specification hh (e.g. 20)

day_of_week string required

Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]

monthly object required

at string required

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ([01][0-9]|[2][0-3])

Default value: 00

Time specification hh (e.g. 20)

day_of_month integer required

Possible values: >= 1 and <= 31

url string required

Possible values: <= 255 characters

Default value: http://

imsi object

auth object

password string required

Possible values: <= 255 characters

username string required

Possible values: non-empty and <= 255 characters

certificate_profile string

Default value: None

Profile for authenticating client certificates

description string

Possible values: <= 255 characters

exception_list string[]

Possible values: <= 34 characters

recurring object required

oneOf

five_minute
hourly
daily
weekly
monthly

five_minute object required

daily object required

at string required

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ([01][0-9]|[2][0-3])

Default value: 00

Time specification hh (e.g. 20)

weekly object required

at string required

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ([01][0-9]|[2][0-3])

Default value: 00

Time specification hh (e.g. 20)

day_of_week string required

Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]

monthly object required

at string required

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ([01][0-9]|[2][0-3])

Default value: 00

Time specification hh (e.g. 20)

day_of_month integer required

Possible values: >= 1 and <= 31

url string required

Possible values: <= 255 characters

Default value: http://

imei object

auth object

password string required

Possible values: <= 255 characters

username string required

Possible values: non-empty and <= 255 characters

certificate_profile string

Default value: None

Profile for authenticating client certificates

description string

Possible values: <= 255 characters

exception_list string[]

Possible values: <= 32 characters

recurring object required

oneOf

five_minute
hourly
daily
weekly
monthly

five_minute object required

daily object required

at string required

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ([01][0-9]|[2][0-3])

Default value: 00

Time specification hh (e.g. 20)

weekly object required

at string required

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ([01][0-9]|[2][0-3])

Default value: 00

Time specification hh (e.g. 20)

day_of_week string required

Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]

monthly object required

at string required

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ([01][0-9]|[2][0-3])

Default value: 00

Time specification hh (e.g. 20)

day_of_month integer required

Possible values: >= 1 and <= 31

url string required

Possible values: <= 255 characters

Default value: http://

]

[
  {
    "id": "abcd-1234",
    "name": "string",
    "type": {
      "predefined_ip": {
        "description": "string",
        "exception_list": [
          "string"
        ],
        "url": "string"
      }
    }
  }
]

Bad Request

application/json

Schema

_errors object[]
Array [
code string
details object
help string
message 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

_errors object[]
Array [
code string
details object
help string
message 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 string
details object
help string
message 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 string
details object
help string
message 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

_errors object[]
Array [
code string
details object
help string
message 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"
}

Get an external dynamic list​

Get an external dynamic list