Skip to main content
GET
List Servers

Authorizations

Authorization
string
header
required

API token from Dashboard > Settings > API Tokens.

Query Parameters

status
enum<string> | null

Filter by status. provisioning also matches failed builds.

Available options:
provisioning,
running,
stopped,
restarting,
reinstalling,
restoring,
deleting,
suspended,
pre_order
location
string | null

Filter by location code, such as fra.

Pattern: ^[A-Za-z0-9-]{1,10}$
page
integer
default:1

Page number.

Required range: 1 <= x <= 100000
per_page
integer
default:20

Items per page.

Required range: 1 <= x <= 100

Response

Successful Response

data
Server · object[]
required
pagination
Pagination · object
required