List services

GET

/v1/service/

const url = 'https://example.com/v1/service/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/service/ \
  --header 'Authorization: Bearer <token>'

Return all services for the current account.

Authorizations

jwtAuth
basicAuth

Parameters

Query Parameters

active

boolean

agent

string format: uuid

cursor

string

The pagination cursor value.

label

string

monitor

boolean

page_size

integer

Number of results to return per page.

search

string

A search term.

tags

string

Responses

200

application/json

object

next

string format: uri

nullable

previous

string format: uri

nullable

results

required

Array<object>

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object

account

required

string format: uuid

account_config

required

string format: uuid

active

boolean

agent

string format: uuid

nullable

created_at

required

string format: date-time

events_start_at

required

string format: date-time

current_status

required

integer

current_status_text

required

string

nullable

deactivated_at

string format: date-time

nullable

display_name

string

exe_path

string

required

string format: uuid

instance

string

<= 250 characters

is_sandbox

required

boolean

kubernetes_cluster_name

required

string

label

required

string

<= 1000 characters

listen_addresses

string

modified_at

required

string format: date-time

monitor

boolean

nullable

monitor_ca_file

string

monitor_expected_content

string

monitor_expected_response_code

integer

nullable >= -2147483648 <= 2147483647

monitor_headers

monitor_unexpected_content

string

monitor_url

string

nullable <= 1000 characters

status_descriptions

required

Array<string>

Example

{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "kubernetes_cluster_name": ""
    }
  ]
}