List external dynamic lists

GET 
/sse/config/v1/external-dynamic-lists

Get external dynamic lists.

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 external dynamic lists

application/json

Schema

Schema

data object[]
Array [
id string
uuid of the resource
name stringrequired
Possible values: <= 63 characters
Alphanumeric string [ 0-9a-zA-Z._-]
type object required
oneOf
predefined_ip
predefined_ip object
description string
Possible values: <= 255 characters
exception_list string[]
Possible values: <= 255 characters
url stringrequired
predefined_url
predefined_url object
description string
Possible values: <= 255 characters
exception_list string[]
Possible values: <= 255 characters
url stringrequired
ip
ip object
auth object
password stringrequired
Possible values: <= 255 characters
username stringrequired
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
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
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)
day_of_week stringrequired
Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]
monthly
monthly 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)
day_of_month integerrequired
Possible values: >= 1 and <= 31
url stringrequired
Possible values: <= 255 characters
Default value: http://
domain
domain object
auth object
password stringrequired
Possible values: <= 255 characters
username stringrequired
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
Enable/Disable expand domain
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
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)
day_of_week stringrequired
Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]
monthly
monthly 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)
day_of_month integerrequired
Possible values: >= 1 and <= 31
url stringrequired
Possible values: <= 255 characters
Default value: http://
url
url object
auth object
password stringrequired
Possible values: <= 255 characters
username stringrequired
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
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
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)
day_of_week stringrequired
Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]
monthly
monthly 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)
day_of_month integerrequired
Possible values: >= 1 and <= 31
url stringrequired
Possible values: <= 255 characters
Default value: http://
imsi
imsi object
auth object
password stringrequired
Possible values: <= 255 characters
username stringrequired
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
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
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)
day_of_week stringrequired
Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]
monthly
monthly 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)
day_of_month integerrequired
Possible values: >= 1 and <= 31
url stringrequired
Possible values: <= 255 characters
Default value: http://
imei
imei object
auth object
password stringrequired
Possible values: <= 255 characters
username stringrequired
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
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
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)
day_of_week stringrequired
Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]
monthly
monthly 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)
day_of_month integerrequired
Possible values: >= 1 and <= 31
url stringrequired
Possible values: <= 255 characters
Default value: http://
]
limit number

Default value: 200

offset number

Default value: 0

total number

Example (from schema)

{
  "data": [
    {
      "id": "abcd-1234",
      "name": "string",
      "type": {
        "predefined_ip": {
          "description": "string",
          "exception_list": [
            "string"
          ],
          "url": "string"
        }
      }
    }
  ],
  "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...