Services

Search for a service (e.g. Worker, Executor, etc)

Requires a role with the INFRASTRUCTURE permission (Superadmin-only).

get/api/v1/instance/services/search

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/instance/services/search
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Query parameters

pageinteger required

The current page

sizeinteger required

The current page size

sortstring[] nullable

The sort of current page

stateServiceServiceState[] nullable

The state filter

typeServiceType[] nullable

The server type filter

Response

searchServices 200 response

totalinteger required

Changes

No recorded changes to this operation across all 7 revisions of this API.