API for manipulating Fashion Store routes. It allows all teams to access and define non-wildcard paths to all relevant users in employee realm as well as, some service realm clients (e.g. CMS). Creation of wildcard routes is reserved for maintainers of this API as it requires special care.
Name | Data Type | Description |
---|---|---|
offset
|
long |
the offset for a paginated query, if missing an limit is present it defaults to 0 |
limit
|
long |
the limit for a paginated query |
snapshot-timestamp
|
dateTime |
the timestamp to use for computing the snapshot it is mandatory if offset is present and greater than zero |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
X-Last-Update
|
dateTime |
The timestamp for the last update to the routes (create, update, delete). |
X-Snapshot-Timestamp
|
dateTime |
The timestamp used for computing the snapshot. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
body
|
array [RouteOut] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
body
|
array [Host] | |||||||||||
Properties
Examples
|
Deleting a path is only allowed for a client that is part of the team owning it or has admin credentials.
Name | Data Type | Description |
---|---|---|
id
|
string |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
id
|
string |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
PathOut
|
is_regex
|
boolean | |
has_star
|
boolean | |
created_at
|
dateTime | |
host_ids
|
array [long] | |
uri
|
string | |
created_by
|
string | |
owned_by_team
|
string | |
id
|
string |
[
"{\n \"id\": \"1\",\n \"owned_by_team\": \"coast\",\n \"created_by\": \"user\",\n \"uri\": \"\/cart\",\n \"has_star\": false,\n \"is_regex\": false,\n \"host_ids\": [1, 2],\n \"created_at\": \"1985-04-12T23:20:50.52Z\"\n}\n"
]
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
id
|
string |
Name | Data Type | Description |
---|---|---|
PathPatch
|
host_ids
|
array [long] | |
owned_by_team
|
string |
[
"{\n \"owned_by_team\": \"coast\",\n \"host_ids\": [1, 2]\n}\n"
]
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
PathOut
|
is_regex
|
boolean | |
has_star
|
boolean | |
created_at
|
dateTime | |
host_ids
|
array [long] | |
uri
|
string | |
created_by
|
string | |
owned_by_team
|
string | |
id
|
string |
[
"{\n \"id\": \"1\",\n \"owned_by_team\": \"coast\",\n \"created_by\": \"user\",\n \"uri\": \"\/cart\",\n \"has_star\": false,\n \"is_regex\": false,\n \"host_ids\": [1, 2],\n \"created_at\": \"1985-04-12T23:20:50.52Z\"\n}\n"
]
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
uri
|
string | |
owned_by_team
|
string |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
body
|
array [PathOut] | |||||||||||||||||||||||||||||
Properties
Examples
|
Name | Data Type | Description |
---|---|---|
PathIn
|
owned_by_team
|
string |
defines the team owning this path. |
is_regex
|
boolean |
the path will be serialized as a PathRegexp predicate |
has_star
|
boolean |
the path will be serialized as a PathSubtree predicate |
host_ids
|
array [long] | |
uri
|
string Pattern: .+
|
empty uri are not allowed |
[
"{\n \"uri\": \"\/cart\",\n \"host_ids\": [1, 2]\n}\n"
]
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
PathOut
|
is_regex
|
boolean | |
has_star
|
boolean | |
created_at
|
dateTime | |
host_ids
|
array [long] | |
uri
|
string | |
created_by
|
string | |
owned_by_team
|
string | |
id
|
string |
[
"{\n \"id\": \"1\",\n \"owned_by_team\": \"coast\",\n \"created_by\": \"user\",\n \"uri\": \"\/cart\",\n \"has_star\": false,\n \"is_regex\": false,\n \"host_ids\": [1, 2],\n \"created_at\": \"1985-04-12T23:20:50.52Z\"\n}\n"
]
Deleting a path is only allowed for a client that is part of the team owning it or has admin credentials.
Name | Data Type | Description |
---|---|---|
id
|
string |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
id
|
string |
Name | Data Type | Description |
---|---|---|
embed
|
string |
The subresources to embed (path, hosts) |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
RouteOut
|
path
|
PathOut | |||||||||||||||||||||||||||||
Properties
Examples
|
||||||||||||||||||||||||||||||
hosts
|
array [Host] |
A list of Hosts resolved by host_ids. |
||||||||||||||||||||||||||||
Properties
Examples
|
||||||||||||||||||||||||||||||
host_ids
|
array [long] |
Ids of the hosts to which route has to be applied. This list is a sublist of the host ids for the path. |
||||||||||||||||||||||||||||
endpoint
|
string |
A valid http(s) endpoint that the request should be routed to |
||||||||||||||||||||||||||||
filters
|
array [Filter] |
Definition of filters to be applied. |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
predicates
|
array [Predicate] |
Definition of predicates to be applied |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
created_by
|
string | |||||||||||||||||||||||||||||
disable_at
|
string |
The ISO-8601 date time when the route will be deactivated |
||||||||||||||||||||||||||||
activate_at
|
string |
The ISO-8601 date time when the route will be activated |
||||||||||||||||||||||||||||
created_at
|
string |
The ISO-8601 date time when the route has been created |
||||||||||||||||||||||||||||
description
|
string |
Human readable description for the route |
||||||||||||||||||||||||||||
uses_common_filters
|
boolean |
Specifies if the route uses the configured common filters |
||||||||||||||||||||||||||||
name
|
string Pattern: \[a-zA-Z][a-zA-Z0-9_]*
|
The name of the route in the ROUTE_NAME format |
||||||||||||||||||||||||||||
path_id
|
long | |||||||||||||||||||||||||||||
id
|
long |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
id
|
string |
Name | Data Type | Description |
---|---|---|
RoutePatch
|
host_ids
|
array [long] |
Ids of the hosts to which route has to be applied. This list must be a sublist of the host ids for the path. |
|||||||||||||||||||||||||||||||||||||||
route
|
RouteData | ||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||
description
|
string |
Human readable description for the route |
|||||||||||||||||||||||||||||||||||||||
uses_common_filters
|
boolean |
Specifies if the route uses the configured common filters |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
RouteOut
|
path
|
PathOut | |||||||||||||||||||||||||||||
Properties
Examples
|
||||||||||||||||||||||||||||||
hosts
|
array [Host] |
A list of Hosts resolved by host_ids. |
||||||||||||||||||||||||||||
Properties
Examples
|
||||||||||||||||||||||||||||||
host_ids
|
array [long] |
Ids of the hosts to which route has to be applied. This list is a sublist of the host ids for the path. |
||||||||||||||||||||||||||||
endpoint
|
string |
A valid http(s) endpoint that the request should be routed to |
||||||||||||||||||||||||||||
filters
|
array [Filter] |
Definition of filters to be applied. |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
predicates
|
array [Predicate] |
Definition of predicates to be applied |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
created_by
|
string | |||||||||||||||||||||||||||||
disable_at
|
string |
The ISO-8601 date time when the route will be deactivated |
||||||||||||||||||||||||||||
activate_at
|
string |
The ISO-8601 date time when the route will be activated |
||||||||||||||||||||||||||||
created_at
|
string |
The ISO-8601 date time when the route has been created |
||||||||||||||||||||||||||||
description
|
string |
Human readable description for the route |
||||||||||||||||||||||||||||
uses_common_filters
|
boolean |
Specifies if the route uses the configured common filters |
||||||||||||||||||||||||||||
name
|
string Pattern: \[a-zA-Z][a-zA-Z0-9_]*
|
The name of the route in the ROUTE_NAME format |
||||||||||||||||||||||||||||
path_id
|
long | |||||||||||||||||||||||||||||
id
|
long |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
If the provided token is not an admin token, only routes belonging to the team associated with the provided token are deleted.
Name | Data Type | Description |
---|---|---|
id
|
long |
The route id to filter for |
path_id
|
long |
The path id to filter for |
description
|
string |
The route description to filter for |
uri
|
string |
The path uri to filter for |
owned_by_team
|
string |
The team name to filter for |
name
|
string |
The name of the route to filter for |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
offset
|
long |
the offset for a paginated query, if missing an limit is present it defaults to 0 |
limit
|
long |
the limit for a paginated query |
embed
|
string |
The subresources to embed (path, hosts) |
id
|
long |
The route id to filter for |
path_id
|
long |
The path id to filter for |
description
|
string |
The route description to filter for |
uri
|
string |
The path uri to filter for |
owned_by_team
|
string |
The team name to filter for |
name
|
string |
The name of the route to filter for |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
body
|
array [RouteOut] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
RouteIn
|
host_ids
|
array [long] |
Ids of the hosts to which route has to be applied. This list must be a sublist of the host ids for the path. |
|||||||||||||||||||||||
endpoint
|
string |
A valid http(s) endpoint that the request should be routed to |
|||||||||||||||||||||||
filters
|
array [Filter] |
Definition of filters to be applied. fashionStore() filter is a mandatory filter and must always present |
|||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||
predicates
|
array [Predicate] |
Definition of predicates to be applied |
|||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||
disable_at
|
string |
The ISO-8601 date time when the route will be deactivated |
|||||||||||||||||||||||
activate_at
|
string |
The ISO-8601 date time when the route will be activated |
|||||||||||||||||||||||
description
|
string |
Human readable description for the route |
|||||||||||||||||||||||
uses_common_filters
|
boolean |
Specifies if the route uses the configured common filters |
|||||||||||||||||||||||
name
|
string Pattern: /[A-Z][A-Z0-9_]*
|
The name of the route in the ROUTE_NAME format |
|||||||||||||||||||||||
path_id
|
long |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
RouteOut
|
path
|
PathOut | |||||||||||||||||||||||||||||
Properties
Examples
|
||||||||||||||||||||||||||||||
hosts
|
array [Host] |
A list of Hosts resolved by host_ids. |
||||||||||||||||||||||||||||
Properties
Examples
|
||||||||||||||||||||||||||||||
host_ids
|
array [long] |
Ids of the hosts to which route has to be applied. This list is a sublist of the host ids for the path. |
||||||||||||||||||||||||||||
endpoint
|
string |
A valid http(s) endpoint that the request should be routed to |
||||||||||||||||||||||||||||
filters
|
array [Filter] |
Definition of filters to be applied. |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
predicates
|
array [Predicate] |
Definition of predicates to be applied |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
created_by
|
string | |||||||||||||||||||||||||||||
disable_at
|
string |
The ISO-8601 date time when the route will be deactivated |
||||||||||||||||||||||||||||
activate_at
|
string |
The ISO-8601 date time when the route will be activated |
||||||||||||||||||||||||||||
created_at
|
string |
The ISO-8601 date time when the route has been created |
||||||||||||||||||||||||||||
description
|
string |
Human readable description for the route |
||||||||||||||||||||||||||||
uses_common_filters
|
boolean |
Specifies if the route uses the configured common filters |
||||||||||||||||||||||||||||
name
|
string Pattern: \[a-zA-Z][a-zA-Z0-9_]*
|
The name of the route in the ROUTE_NAME format |
||||||||||||||||||||||||||||
path_id
|
long | |||||||||||||||||||||||||||||
id
|
long |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description |
---|---|---|
timestamp
|
string |
Name | Data Type | Description |
---|---|---|
Error
|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
body
|
array [RouteChange] | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
value
|
A value representing the type |
|
type
|
string |
Must be one of [number, string, regex] |
Name | Data Type | Description |
---|---|---|
detail
|
string |
Detailed description of an error |
title
|
string |
Short description of an error |
status
|
integer | |
type
|
string |
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
args
|
array [Arg] |
The arguments for the filter, can be string or float64 |
||||||||||
Properties
|
||||||||||||
name
|
string |
The name of the filter, as it is definined in Skipper |
Name | Data Type | Description |
---|---|---|
name
|
string | |
id
|
string |
[
"{\n \"id\": \"1\",\n \"name\": \"zalando.de\"\n}\n"
]
Name | Data Type | Description |
---|---|---|
owned_by_team
|
string |
defines the team owning this path. |
is_regex
|
boolean |
the path will be serialized as a PathRegexp predicate |
has_star
|
boolean |
the path will be serialized as a PathSubtree predicate |
host_ids
|
array [long] | |
uri
|
string Pattern: .+
|
empty uri are not allowed |
[
"{\n \"uri\": \"\/cart\",\n \"host_ids\": [1, 2]\n}\n"
]
Name | Data Type | Description |
---|---|---|
is_regex
|
boolean | |
has_star
|
boolean | |
created_at
|
dateTime | |
host_ids
|
array [long] | |
uri
|
string | |
created_by
|
string | |
owned_by_team
|
string | |
id
|
string |
[
"{\n \"id\": \"1\",\n \"owned_by_team\": \"coast\",\n \"created_by\": \"user\",\n \"uri\": \"\/cart\",\n \"has_star\": false,\n \"is_regex\": false,\n \"host_ids\": [1, 2],\n \"created_at\": \"1985-04-12T23:20:50.52Z\"\n}\n"
]
Name | Data Type | Description |
---|---|---|
host_ids
|
array [long] | |
owned_by_team
|
string |
[
"{\n \"owned_by_team\": \"coast\",\n \"host_ids\": [1, 2]\n}\n"
]
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
args
|
array [Arg] |
The arguments for the predicate, can be string or float64 |
||||||||||
Properties
|
||||||||||||
name
|
string |
The name of the predicate, as it is definined in Skipper |
Name | Data Type | Description |
---|---|---|
eskip
|
string |
The Route in eskip format |
name
|
string |
Route name |
timestamp
|
string |
The ISO-8601 date time when the route will be activated |
type
|
string |
the type of the RouteChange (create update or delete) |
Name | Data Type | Description | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
endpoint
|
string |
A valid http(s) endpoint that the request should be routed to |
|||||||||||||||||||||||
filters
|
array [Filter] |
Definition of filters to be applied. |
|||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||
predicates
|
array [Predicate] |
Definition of predicates to be applied |
|||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
host_ids
|
array [long] |
Ids of the hosts to which route has to be applied. This list must be a sublist of the host ids for the path. |
|||||||||||||||||||||||
endpoint
|
string |
A valid http(s) endpoint that the request should be routed to |
|||||||||||||||||||||||
filters
|
array [Filter] |
Definition of filters to be applied. fashionStore() filter is a mandatory filter and must always present |
|||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||
predicates
|
array [Predicate] |
Definition of predicates to be applied |
|||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||
disable_at
|
string |
The ISO-8601 date time when the route will be deactivated |
|||||||||||||||||||||||
activate_at
|
string |
The ISO-8601 date time when the route will be activated |
|||||||||||||||||||||||
description
|
string |
Human readable description for the route |
|||||||||||||||||||||||
uses_common_filters
|
boolean |
Specifies if the route uses the configured common filters |
|||||||||||||||||||||||
name
|
string Pattern: /[A-Z][A-Z0-9_]*
|
The name of the route in the ROUTE_NAME format |
|||||||||||||||||||||||
path_id
|
long |
Name | Data Type | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
path
|
PathOut | |||||||||||||||||||||||||||||
Properties
Examples
|
||||||||||||||||||||||||||||||
hosts
|
array [Host] |
A list of Hosts resolved by host_ids. |
||||||||||||||||||||||||||||
Properties
Examples
|
||||||||||||||||||||||||||||||
host_ids
|
array [long] |
Ids of the hosts to which route has to be applied. This list is a sublist of the host ids for the path. |
||||||||||||||||||||||||||||
endpoint
|
string |
A valid http(s) endpoint that the request should be routed to |
||||||||||||||||||||||||||||
filters
|
array [Filter] |
Definition of filters to be applied. |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
predicates
|
array [Predicate] |
Definition of predicates to be applied |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
created_by
|
string | |||||||||||||||||||||||||||||
disable_at
|
string |
The ISO-8601 date time when the route will be deactivated |
||||||||||||||||||||||||||||
activate_at
|
string |
The ISO-8601 date time when the route will be activated |
||||||||||||||||||||||||||||
created_at
|
string |
The ISO-8601 date time when the route has been created |
||||||||||||||||||||||||||||
description
|
string |
Human readable description for the route |
||||||||||||||||||||||||||||
uses_common_filters
|
boolean |
Specifies if the route uses the configured common filters |
||||||||||||||||||||||||||||
name
|
string Pattern: \[a-zA-Z][a-zA-Z0-9_]*
|
The name of the route in the ROUTE_NAME format |
||||||||||||||||||||||||||||
path_id
|
long | |||||||||||||||||||||||||||||
id
|
long |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
host_ids
|
array [long] |
Ids of the hosts to which route has to be applied. This list must be a sublist of the host ids for the path. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
route
|
RouteData | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description
|
string |
Human readable description for the route |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uses_common_filters
|
boolean |
Specifies if the route uses the configured common filters |
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
implicit
https://auth.provider.com/z/XUI/#login/
routes.read
: Reading (listing) all the routes
routes.admin
: All operations on all routes, including ones with regex path matching.
routes.write
: All operations on routes with strict path matching.
API Version | 3.0.0 |