List App Instances - Serval Documentation

GET

app-instances

List App Instances

curl --request GET \
  --url https://public.api.serval.com/v2/app-instances \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "customServiceId": "<string>",
      "service": "<string>",
      "id": "<string>",
      "teamId": "<string>",
      "externalServiceInstanceId": "<string>",
      "name": "<string>",
      "accessRequestsEnabled": true,
      "defaultAccessPolicyId": "<string>",
      "customServiceName": "<string>",
      "tagIds": [
        "<string>"
      ]
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

teamId

string

The ID of the team.

pageSize

integer<int32>

Maximum number of results to return. Default is 10000, maximum is 10000.

pageToken

string

Token for pagination. Leave empty for the first request.

Response

Success

data

AppInstance · object[]

The list of app instances.

Show child attributes

nextPageToken

string | null

Token for retrieving the next page of results. Empty if no more results.

List App Instances

curl --request GET \
  --url https://public.api.serval.com/v2/app-instances \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "customServiceId": "<string>",
      "service": "<string>",
      "id": "<string>",
      "teamId": "<string>",
      "externalServiceInstanceId": "<string>",
      "name": "<string>",
      "accessRequestsEnabled": true,
      "defaultAccessPolicyId": "<string>",
      "customServiceName": "<string>",
      "tagIds": [
        "<string>"
      ]
    }
  ],
  "nextPageToken": "<string>"
}