latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Service

Get services

Retrieve a list of services in this organization.

Permissions

This endpoint is impacted by the following permissions:

  • Only services that the authenticated user has the Service:GetService permission for are returned.
get/v1/{organization}/service/

Path parameters

organizationstring required

Query parameters

idstring[]

The IDs of the services to retrieve.

The IDs of the services to retrieve.

is_activeboolean nullable

Whether the service is active.

Whether the service is active.

sort_bystring[]

The fields to sort the services by. Supported fields are name and is_active. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

The fields to sort the services by. Supported fields are name and is_active. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

tagsstring[]

The tags to filter the services by. Must be specified using the syntax key:value, which means to match all services with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.

The tags to filter the services by. Must be specified using the syntax key:value, which means to match all services with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.

limitinteger

The maximum number of services to return.

The maximum number of services to return.

continuation_tokeninteger

The continuation token from the previous request used to retrieve the next page of services.

The continuation token from the previous request used to retrieve the next page of services.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Succeeded.

has_moreboolean required

Whether there are more services to retrieve.

continuation_tokeninteger nullable required

A token to supply to the next request to retrieve the next page of services. Only populated if has_more is True.