Skip to main content
GET
List servers

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Query Parameters

cursor
string

Opaque cursor pointing at the next page. Omit it to read the first page.

limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
sort_by
enum<string>
default:created_at

Sort field. Defaults to "created_at". The "name" field sorts by hostname.

Available options:
name,
status,
created_at
sort_order
enum<string>
default:desc

Sort order. Defaults to "desc".

Available options:
asc,
desc
project_reference
string

Project ID or slug. When set, the operation acts on that project’s servers with the project checks (project.read to read, project.runtime.manage to create or delete) instead of on the servers you own.

Response

One page of the servers you own, or of the project’s servers

data
object[]
required
page_info
object
required