Skip to main content
GET
List servers

Headers

X-Network-ID
string
required

Network ID

X-Network-Credential
string
required

Network Credential (network password or JWT)

Query Parameters

server_id
string

Filter by server ID(s), comma-separated

server_group_id
string

Filter by server group ID(s), comma-separated

state
string

Filter by state(s), comma-separated (e.g., AVAILABLE,STARTING)

serverhost_id
string

Filter by serverhost ID(s), comma-separated

persistent_server_id
string

Filter by persistent server ID(s), comma-separated

type
string

Filter by type(s), comma-separated (matches server group type OR persistent server type)

name
string

Filter by name(s), comma-separated (matches server group name OR persistent server name)

tags
string

Filter by tag(s), comma-separated (matches if any tag matches in server group OR persistent server)

numerical_id
string

Filter by numerical ID(s), comma-separated (e.g., 1,5,10)

sort_by
string

Sort field: created_at, updated_at, numerical_id, state

sort_order
enum<string>
default:asc

Sort order: asc, desc

Available options:
asc,
desc
limit
integer

Maximum number of results (1-500)

offset
integer
default:0

Number of results to skip; requires limit

Response

OK

Response for listing servers

count
integer
Example:

5

servers
object[]