List External Dynamic Lists

GET 
/external-dynamic-lists

Retrieve a list of External Dynamic Lists.

Request

Query Parameters

name string

The name of the configuration resource

folder string

The folder in which the resource is defined

snippet string

The snippet in which the resource is defined

device string

The device in which the resource is defined

offset number

Default value: 0

The offset into the list of results returned

limit number

Default value: 200

The maximum number of results per page

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
id stringrequired
The UUID of the external dynamic list
name stringrequired
Possible values: <= 63 characters, Value must match regular expression ^[ a-zA-Z\d.-_]+$
The name of the external dynamic list
type object required
oneOf
predefined_ip
predefined_ip object
exception_list string[]
Possible values: <= 255 characters
description string
Possible values: <= 255 characters
url stringrequired
predefined_url
predefined_url object
exception_list string[]
Possible values: <= 255 characters
description string
Possible values: <= 255 characters
url stringrequired
ip
ip object
exception_list string[]
Possible values: <= 255 characters
description string
Possible values: <= 255 characters
url stringrequired
Possible values: <= 255 characters
Default value: http://
certificate_profile string
Default value: None
Profile for authenticating client certificates
auth object
username stringrequired
Possible values: non-empty and <= 255 characters
password passwordrequired
Possible values: <= 255 characters
recurring object required
oneOf
five_minute
five_minute objectrequired
hourly
hourly objectrequired
daily
daily objectrequired
at stringrequired
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
weekly objectrequired
day_of_week required
Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]
at stringrequired
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)
monthly
monthly objectrequired
day_of_month integerrequired
Possible values: >= 1 and <= 31
at stringrequired
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)
domain
domain object
exception_list string[]
Possible values: <= 255 characters
description string
Possible values: <= 255 characters
url stringrequired
Possible values: <= 255 characters
Default value: http://
certificate_profile string
Default value: None
Profile for authenticating client certificates
auth object
username stringrequired
Possible values: non-empty and <= 255 characters
password stringrequired
Possible values: <= 255 characters
recurring object required
oneOf
hourly
hourly objectrequired
five_minute
five_minute objectrequired
daily
daily objectrequired
at stringrequired
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
weekly objectrequired
day_of_week required
Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]
at stringrequired
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)
monthly
monthly objectrequired
day_of_month integerrequired
Possible values: >= 1 and <= 31
at stringrequired
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)
expand_domain boolean
Enable/Disable expand domain
url
url object
exception_list string[]
Possible values: <= 255 characters
description string
Possible values: <= 255 characters
url stringrequired
Possible values: <= 255 characters
Default value: http://
certificate_profile string
Default value: None
Profile for authenticating client certificates
auth object
username stringrequired
Possible values: non-empty and <= 255 characters
password stringrequired
Possible values: <= 255 characters
recurring object required
oneOf
hourly
hourly objectrequired
five_minute
five_minute objectrequired
daily
daily objectrequired
at stringrequired
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
weekly objectrequired
day_of_week required
Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]
at stringrequired
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)
monthly
monthly objectrequired
day_of_month integerrequired
Possible values: >= 1 and <= 31
at stringrequired
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)
imsi
imsi object
exception_list string[]
Possible values: <= 34 characters
description string
Possible values: <= 255 characters
url stringrequired
Possible values: <= 255 characters
Default value: http://
certificate_profile string
Default value: None
Profile for authenticating client certificates
auth object
username stringrequired
Possible values: non-empty and <= 255 characters
password stringrequired
Possible values: <= 255 characters
recurring object required
oneOf
five_minute
five_minute objectrequired
hourly
hourly objectrequired
daily
daily objectrequired
at stringrequired
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
weekly objectrequired
day_of_week required
Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]
at stringrequired
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)
monthly
monthly objectrequired
day_of_month integerrequired
Possible values: >= 1 and <= 31
at stringrequired
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)
imei
imei object
exception_list string[]
Possible values: <= 32 characters
description string
Possible values: <= 255 characters
url stringrequired
Possible values: <= 255 characters
Default value: http://
certificate_profile string
Default value: None
Profile for authenticating client certificates
auth object
username stringrequired
Possible values: non-empty and <= 255 characters
password stringrequired
Possible values: <= 255 characters
recurring object required
oneOf
five_minute
five_minute objectrequired
hourly
hourly objectrequired
daily
daily objectrequired
at stringrequired
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
weekly objectrequired
day_of_week required
Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]
at stringrequired
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)
monthly
monthly objectrequired
day_of_month integerrequired
Possible values: >= 1 and <= 31
at stringrequired
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)
]
limit number

Default value: 200

offset number

Default value: 0

total number

Example (from schema)

{
  "data": [
    {
      "folder": "My Folder"
    },
    {
      "snippet": "My Snippet"
    },
    {
      "device": "My Device"
    }
  ],
  "limit": 200,
  "offset": 0,
  "total": 0
}

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...