Zalando SE - API Innkeeper (Route Manager)

Zalando SE / Innkeeper (Route Manager)

Innkeeper (Route Manager)

ecommerce

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.

Resources

GET

/current-routes

Returns the list of all the active routes.

Request

Query

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

Responses

200A processing or an unexpected error.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

200An array of routes

Header

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.

Body

Name Data Type Description

body array [RouteOut]

RouteOut

Properties

path PathOut

PathOut

Properties

`is_regex`	boolean
`has_star`	boolean
`created_at`	dateTime
`host_ids`	array [long]
`uri`	string
`created_by`	string
`owned_by_team`	string
`id`	string

Examples

[
    "{\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"
]


                        hosts

array [Host]

A list of Hosts resolved by host_ids.

Host

Properties

`name`	string
`id`	string

Examples

[
    "{\n  \"id\": \"1\",\n  \"name\": \"zalando.de\"\n}\n"
]


                        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.

Filter

Properties

`args`	array [Arg]	The arguments for the filter, can be string or float64
`name`	string	The name of the filter, as it is definined in Skipper


                        predicates

array [Predicate]

Definition of predicates to be applied

Predicate

Properties

`args`	array [Arg]	The arguments for the predicate, can be string or float64
`name`	string	The name of the predicate, as it is definined in Skipper

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

GET

/hosts

Returns the list of available hosts.

Responses

200A processing or an unexpected error.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

200An array of available hosts.

Body

Name Data Type Description

body array [Host]

Host

Properties

`name`	string
`id`	string

Examples

[
    "{\n  \"id\": \"1\",\n  \"name\": \"zalando.de\"\n}\n"
]

DELETE

/paths/{id}

Deleting a path is only allowed for a client that is part of the team owning it or has admin credentials.

Request

Path

Name	Data Type	Description
`id`	string

Responses

200A processing or an unexpected error.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

200Empty response

403Happens in a case of insufficient permissions.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

404Happens when trying to delete a non-existent Path.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

GET

/paths/{id}

Information about a single path.

Request

Path

Name	Data Type	Description
`id`	string

Responses

200A processing or an unexpected error.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

200A path with a given `id`.

Body

Name	Data Type	Description
`PathOut`

Properties

`is_regex`	boolean
`has_star`	boolean
`created_at`	dateTime
`host_ids`	array [long]
`uri`	string
`created_by`	string
`owned_by_team`	string
`id`	string

Examples

[
    "{\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"
]

404Happens when path does not exist.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

PATCH

/paths/{id}

Partially update a path.

Request

Path

Name	Data Type	Description
`id`	string

Body

Name	Data Type	Description
`PathPatch`

Properties

`host_ids`	array [long]
`owned_by_team`	string

Examples

[
    "{\n  \"owned_by_team\": \"coast\",\n  \"host_ids\": [1, 2]\n}\n"
]

Responses

200A processing or an unexpected error.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

200The updated path.

Body

Name	Data Type	Description
`PathOut`

Properties

`is_regex`	boolean
`has_star`	boolean
`created_at`	dateTime
`host_ids`	array [long]
`uri`	string
`created_by`	string
`owned_by_team`	string
`id`	string

Examples

[
    "{\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"
]

404Happens when path does not exist.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

GET

/paths

A list of available paths.

Request

Query

Name	Data Type	Description
`uri`	string
`owned_by_team`	string

Responses

200A processing or an unexpected error.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

200Array of paths.

Body

Name Data Type Description

body array [PathOut]

PathOut

Properties

`is_regex`	boolean
`has_star`	boolean
`created_at`	dateTime
`host_ids`	array [long]
`uri`	string
`created_by`	string
`owned_by_team`	string
`id`	string

Examples

[
    "{\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"
]

POST

/paths

Creates a new path resource that belongs to the team of the creator.

Request

Body

Name	Data Type	Description
`PathIn`

Properties

`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

Examples

[
    "{\n  \"uri\": \"\/cart\",\n  \"host_ids\": [1, 2]\n}\n"
]

Responses

200A processing or an unexpected error.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

201The path is created.

Body

Name	Data Type	Description
`PathOut`

Properties

`is_regex`	boolean
`has_star`	boolean
`created_at`	dateTime
`host_ids`	array [long]
`uri`	string
`created_by`	string
`owned_by_team`	string
`id`	string

Examples

[
    "{\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"
]

DELETE

/routes/{id}

Deleting a path is only allowed for a client that is part of the team owning it or has admin credentials.

Request

Path

Name	Data Type	Description
`id`	string

Responses

200A processing or an unexpected error.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

200Empty response

403Happens in a case of insufficient permissions.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

404Happens when trying to delete a non-existent Route.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

GET

/routes/{id}

Information about a single route.

Request

Path

Name	Data Type	Description
`id`	string

Query

Name	Data Type	Description
`embed`	string	The subresources to embed (path, hosts)

Responses

200A processing or an unexpected error.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

200A route with a given `id`.

Body

Name	Data Type	Description
`RouteOut`

Properties

path PathOut

PathOut

Properties

`is_regex`	boolean
`has_star`	boolean
`created_at`	dateTime
`host_ids`	array [long]
`uri`	string
`created_by`	string
`owned_by_team`	string
`id`	string

Examples

[
    "{\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"
]


                        hosts

array [Host]

A list of Hosts resolved by host_ids.

Host

Properties

`name`	string
`id`	string

Examples

[
    "{\n  \"id\": \"1\",\n  \"name\": \"zalando.de\"\n}\n"
]


                        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.

Filter

Properties


                        args

array [Arg]

The arguments for the filter, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the filter, as it is definined in Skipper


                        predicates

array [Predicate]

Definition of predicates to be applied

Predicate

Properties


                        args

array [Arg]

The arguments for the predicate, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the predicate, as it is definined in Skipper

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

404Happens when trying to access a non-existent Route.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

PATCH

/routes/{id}

Partially update a route.

Request

Path

Name	Data Type	Description
`id`	string

Body

Name	Data Type	Description
`RoutePatch`

Properties


                        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

RouteData

Properties


                        endpoint

string

A valid http(s) endpoint that the request should be routed to


                        filters

array [Filter]

Definition of filters to be applied.

Filter

Properties

`args`	array [Arg]	The arguments for the filter, can be string or float64
`name`	string	The name of the filter, as it is definined in Skipper


                        predicates

array [Predicate]

Definition of predicates to be applied

Predicate

Properties

`args`	array [Arg]	The arguments for the predicate, can be string or float64
`name`	string	The name of the predicate, as it is definined in Skipper


                        description

string

Human readable description for the route


                        uses_common_filters

boolean

Specifies if the route uses the configured common filters

Responses

200A processing or an unexpected error.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

200The updated route.

Body

Name	Data Type	Description
`RouteOut`

Properties

path PathOut

PathOut

Properties

`is_regex`	boolean
`has_star`	boolean
`created_at`	dateTime
`host_ids`	array [long]
`uri`	string
`created_by`	string
`owned_by_team`	string
`id`	string

Examples

[
    "{\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"
]


                        hosts

array [Host]

A list of Hosts resolved by host_ids.

Host

Properties

`name`	string
`id`	string

Examples

[
    "{\n  \"id\": \"1\",\n  \"name\": \"zalando.de\"\n}\n"
]


                        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.

Filter

Properties


                        args

array [Arg]

The arguments for the filter, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the filter, as it is definined in Skipper


                        predicates

array [Predicate]

Definition of predicates to be applied

Predicate

Properties


                        args

array [Arg]

The arguments for the predicate, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the predicate, as it is definined in Skipper

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

403Usually happens in a case of insufficient permissions.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

DELETE

/routes

If the provided token is not an admin token, only routes belonging to the team associated with the provided token are deleted.

Request

Query

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

Responses

200A processing or an unexpected error.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

200The amount of routes that were deleted.

403Happens in a case of insufficient permissions.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

GET

/routes

Returns the list of all the routes.

Request

Query

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

Responses

200A processing or an unexpected error.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

200An array of routes

Body

Name Data Type Description

body array [RouteOut]

RouteOut

Properties

path PathOut

PathOut

Properties

`is_regex`	boolean
`has_star`	boolean
`created_at`	dateTime
`host_ids`	array [long]
`uri`	string
`created_by`	string
`owned_by_team`	string
`id`	string

Examples

[
    "{\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"
]


                        hosts

array [Host]

A list of Hosts resolved by host_ids.

Host

Properties

`name`	string
`id`	string

Examples

[
    "{\n  \"id\": \"1\",\n  \"name\": \"zalando.de\"\n}\n"
]


                        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.

Filter

Properties

`args`	array [Arg]	The arguments for the filter, can be string or float64
`name`	string	The name of the filter, as it is definined in Skipper


                        predicates

array [Predicate]

Definition of predicates to be applied

Predicate

Properties

`args`	array [Arg]	The arguments for the predicate, can be string or float64
`name`	string	The name of the predicate, as it is definined in Skipper

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

POST

/routes

Creating a route with specified name.

Request

Body

Name	Data Type	Description
`RouteIn`

Properties


                        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

Filter

Properties


                        args

array [Arg]

The arguments for the filter, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the filter, as it is definined in Skipper


                        predicates

array [Predicate]

Definition of predicates to be applied

Predicate

Properties


                        args

array [Arg]

The arguments for the predicate, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the predicate, as it is definined in Skipper


                        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

Responses

200A processing or an unexpected error.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

201The route is created.

Body

Name	Data Type	Description
`RouteOut`

Properties

path PathOut

PathOut

Properties

`is_regex`	boolean
`has_star`	boolean
`created_at`	dateTime
`host_ids`	array [long]
`uri`	string
`created_by`	string
`owned_by_team`	string
`id`	string

Examples

[
    "{\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"
]


                        hosts

array [Host]

A list of Hosts resolved by host_ids.

Host

Properties

`name`	string
`id`	string

Examples

[
    "{\n  \"id\": \"1\",\n  \"name\": \"zalando.de\"\n}\n"
]


                        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.

Filter

Properties


                        args

array [Arg]

The arguments for the filter, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the filter, as it is definined in Skipper


                        predicates

array [Predicate]

Definition of predicates to be applied

Predicate

Properties


                        args

array [Arg]

The arguments for the predicate, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the predicate, as it is definined in Skipper

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

403Usually happens in a case of insufficient permissions.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

GET

/updated-routes/{timestamp}

Returns a list of route updates after the provided timestamp.

Request

Path

Name	Data Type	Description
`timestamp`	string

Responses

200A processing or an unexpected error.

Body

Name	Data Type	Description
`Error`

Properties

`detail`	string	Detailed description of an error
`title`	string	Short description of an error
`status`	integer
`type`	string

200An array of route updates

Body

Name Data Type Description

body array [RouteChange]

RouteChange

Properties

`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)

Models

Arg

Error

Filter

Host

PathIn

PathOut

Properties

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

Examples

[
    "{\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"
]

PathPatch

Predicate

RouteChange

RouteData

Properties

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.

Filter

Properties


                        args

array [Arg]

The arguments for the filter, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the filter, as it is definined in Skipper


                        predicates

array [Predicate]

Definition of predicates to be applied

Predicate

Properties


                        args

array [Arg]

The arguments for the predicate, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the predicate, as it is definined in Skipper

RouteIn

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

Filter

Properties


                        args

array [Arg]

The arguments for the filter, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the filter, as it is definined in Skipper


                        predicates

array [Predicate]

Definition of predicates to be applied

Predicate

Properties


                        args

array [Arg]

The arguments for the predicate, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the predicate, as it is definined in Skipper


                        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

RouteOut

Properties

Name Data Type Description

path PathOut

PathOut

Properties

`is_regex`	boolean
`has_star`	boolean
`created_at`	dateTime
`host_ids`	array [long]
`uri`	string
`created_by`	string
`owned_by_team`	string
`id`	string

Examples

[
    "{\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"
]


                        hosts

array [Host]

A list of Hosts resolved by host_ids.

Host

Properties

`name`	string
`id`	string

Examples

[
    "{\n  \"id\": \"1\",\n  \"name\": \"zalando.de\"\n}\n"
]


                        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.

Filter

Properties


                        args

array [Arg]

The arguments for the filter, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the filter, as it is definined in Skipper


                        predicates

array [Predicate]

Definition of predicates to be applied

Predicate

Properties


                        args

array [Arg]

The arguments for the predicate, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the predicate, as it is definined in Skipper

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

RoutePatch

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.

route RouteData

RouteData

Properties


                        endpoint

string

A valid http(s) endpoint that the request should be routed to


                        filters

array [Filter]

Definition of filters to be applied.

Filter

Properties


                        args

array [Arg]

The arguments for the filter, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the filter, as it is definined in Skipper


                        predicates

array [Predicate]

Definition of predicates to be applied

Predicate

Properties


                        args

array [Arg]

The arguments for the predicate, can be string or float64

Arg

Properties

`value`		A value representing the type
`type`	string	Must be one of [number, string, regex]


                        name

string

The name of the predicate, as it is definined in Skipper


                        description

string

Human readable description for the route


                        uses_common_filters

boolean

Specifies if the route uses the configured common filters

Authentication

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Flow: implicit
Authorization URL: https://auth.provider.com/z/XUI/#login/
Scopes:

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.

Metadata (Technical Details)

API Version 3.0.0

Comments

Loading comments ...