List external dynamic lists
Get external dynamic lists.
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 external dynamic lists
- application/json
- Schema
- Example (from schema)
Schema
data object[]
Array [id stringuuid of the resource
name string requiredPossible values:
<= 63 charactersAlphanumeric string [ 0-9a-zA-Z._-]
type object required
- oneOf
- predefined_ip
- predefined_url
- ip
- domain
- url
- imsi
- imei
predefined_ip object
description stringPossible values:
<= 255 charactersexception_list string[]Possible values:
<= 255 charactersurl string requiredpredefined_url object
description stringPossible values:
<= 255 charactersexception_list string[]Possible values:
<= 255 charactersurl string requiredip object
auth object
password string requiredPossible values:
<= 255 charactersusername string requiredPossible values:
non-emptyand<= 255 characterscertificate_profile stringDefault value:
NoneProfile for authenticating client certificates
description stringPossible values:
<= 255 charactersexception_list string[]Possible values:
<= 255 charactersrecurring object required
- oneOf
- five_minute
- hourly
- daily
- weekly
- monthly
five_minute object requiredhourly object requireddaily object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
weekly object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
day_of_week string requiredPossible values: [
sunday,monday,tuesday,wednesday,thursday,friday,saturday]monthly object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
day_of_month integer requiredPossible values:
>= 1and<= 31url string requiredPossible values:
<= 255 charactersDefault value:
http://domain object
auth object
password string requiredPossible values:
<= 255 charactersusername string requiredPossible values:
non-emptyand<= 255 characterscertificate_profile stringDefault value:
NoneProfile for authenticating client certificates
description stringPossible values:
<= 255 charactersexception_list string[]Possible values:
<= 255 charactersexpand_domain booleanDefault value:
falseEnable/Disable expand domain
recurring object required
- oneOf
- hourly
- five_minute
- daily
- weekly
- monthly
hourly object requiredfive_minute object requireddaily object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
weekly object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
day_of_week string requiredPossible values: [
sunday,monday,tuesday,wednesday,thursday,friday,saturday]monthly object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
day_of_month integer requiredPossible values:
>= 1and<= 31url string requiredPossible values:
<= 255 charactersDefault value:
http://url object
auth object
password string requiredPossible values:
<= 255 charactersusername string requiredPossible values:
non-emptyand<= 255 characterscertificate_profile stringDefault value:
NoneProfile for authenticating client certificates
description stringPossible values:
<= 255 charactersexception_list string[]Possible values:
<= 255 charactersrecurring object required
- oneOf
- hourly
- five_minute
- daily
- weekly
- monthly
hourly object requiredfive_minute object requireddaily object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
weekly object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
day_of_week string requiredPossible values: [
sunday,monday,tuesday,wednesday,thursday,friday,saturday]monthly object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
day_of_month integer requiredPossible values:
>= 1and<= 31url string requiredPossible values:
<= 255 charactersDefault value:
http://imsi object
auth object
password string requiredPossible values:
<= 255 charactersusername string requiredPossible values:
non-emptyand<= 255 characterscertificate_profile stringDefault value:
NoneProfile for authenticating client certificates
description stringPossible values:
<= 255 charactersexception_list string[]Possible values:
<= 34 charactersrecurring object required
- oneOf
- five_minute
- hourly
- daily
- weekly
- monthly
five_minute object requiredhourly object requireddaily object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
weekly object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
day_of_week string requiredPossible values: [
sunday,monday,tuesday,wednesday,thursday,friday,saturday]monthly object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
day_of_month integer requiredPossible values:
>= 1and<= 31url string requiredPossible values:
<= 255 charactersDefault value:
http://imei object
auth object
password string requiredPossible values:
<= 255 charactersusername string requiredPossible values:
non-emptyand<= 255 characterscertificate_profile stringDefault value:
NoneProfile for authenticating client certificates
description stringPossible values:
<= 255 charactersexception_list string[]Possible values:
<= 32 charactersrecurring object required
- oneOf
- five_minute
- hourly
- daily
- weekly
- monthly
five_minute object requiredhourly object requireddaily object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
weekly object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
day_of_week string requiredPossible values: [
sunday,monday,tuesday,wednesday,thursday,friday,saturday]monthly object required
at string requiredPossible values:
>= 2 charactersand<= 2 characters, Value must match regular expression([01][0-9]|[2][0-3])Default value:
00Time specification hh (e.g. 20)
day_of_month integer requiredPossible values:
>= 1and<= 31url string requiredPossible values:
<= 255 charactersDefault value:
http://]- limit number
Default value:
200 - offset number
Default value:
0 - total number
{
"data": [
{
"id": "abcd-1234",
"name": "string",
"type": {
"predefined_ip": {
"description": "string",
"exception_list": [
"string"
],
"url": "string"
}
}
}
],
"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"
}