Retrieve log shipping tokens

POST /v1/log-shipping/tokens/search

Returns the relevant shipping tokens, filtered, sorted and paginated as per the request. Please ensure to change the region in the URL to match your account's region.

Request

application/json

Body

filter object

Filters your search for token attributes.

enabled booleanrequired

Set to true to filter for enabled tokens. Set to false to filter for disabled tokens.

sort object[]

Sorts the results before returning them.

Array [

field string

Possible values: [CREATED_AT, NAME]

To sort by creation date, use "createdAt". To sort by name, use "name".

descending boolean

For descending order, use true. For ascending order, use false.

]

pagination object

Default pagination is a page of 25 results. Look for the total field in the response for the number of available results overall, and use the pagination function to page through the results.

pageNumber int32

Default value: 1

If you overshoot the page number, it will return empty with no results, but it won't fail the request.

pageSize int32

Possible values: <= 1000

Default value: 25

Controls the number of results per page. Valid inputs are 1 to 1000.

Responses

successful operation

application/json

Schema
Example (from schema)

Schema

total int32

results object[]

Array [

name string

This token's name.

id int32

This token's ID.

token string

The token itself.

updatedAt string

Unix timestamp of when this token was last updated.

updatedBy string

Email address of the last user to update this token.

createdAt string

Unix timestamp of when this token was created.

createdBy string

Email address of the user who created this token.

enabled boolean

If this token is enabled, true. If it's disabled, false.

]