Skip to main content
GET
List persistent servers

Headers

X-Network-ID
string
required

Network ID

X-Network-Credential
string
required

Network Credential (network password or JWT)

Query Parameters

persistent_server_id
string

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

name
string

Filter by exact name(s), comma-separated

type
string

Filter by type(s), comma-separated (SERVER, PROXY)

tags
string

Filter by tag(s), comma-separated; matches any tag

active
boolean

Filter by active status (true/false)

source_type
string

Filter by source type(s), comma-separated (blueprint, image)

blueprint_id
string

Filter by blueprint ID(s), comma-separated

serverhost_id
string

Filter by serverhost ID(s), comma-separated

limit
integer

Maximum number of results (1-500)

offset
integer
default:0

Number of results to skip; requires limit

Response

OK

Response for listing persistent servers

count
integer
Example:

5

persistent_servers
object[]