Skip to content

List services

GET
/v1/service/

Return all services for the current account.

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
object
next
string format: uri
nullable
Example
http://api.example.org/accounts/?cursor=cD00ODY%3D"
previous
string format: uri
nullable
Example
http://api.example.org/accounts/?cursor=cj0xJnA9NDg3
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
id
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>