v7

latestOpenAPI 3.0.12026-08-03158127387.0 KB
Servers

List servers

Returns a list of all servers belonging to the team.

get/servers

Query parameters

filter[project]string

The project ID or Slug to filter by

filter[region]string

The region Slug to filter by

filter[hostname]string

The hostname of server to filter by

filter[created_at_gte]string

The created at greater than equal date to filter by

filter[created_at_lte]string

The created at less than equal date to filter by

filter[label]string

The label of server to filter by

filter[status]string

The status of server to filter by

filter[plan]string

The platform/plan name of the server to filter by

filter[gpu]boolean

Filter by the existence of an associated GPU

filter[ram][eql]integer

Filter servers with RAM size (in GB) equals the provided value.

filter[ram][gte]integer

Filter servers with RAM size (in GB) greater than or equal the provided value.

filter[ram][lte]integer

Filter servers with RAM size (in GB) less than or equal the provided value.

filter[disk][eql]integer

Filter servers with disk size (in GB) equal to the provided value.

filter[disk][gte]integer

Filter servers with disk size (in GB) greater than or equal to the provided value.

filter[disk][lte]integer

Filter servers with disk size (in GB) less than or equal to the provided value.

filter[tags]string

The tags IDs to filter by, separated by comma, e.g. filter[tags]=tag_1,tag_2will return servers with tag_1 AND tag_2

extra_fields[servers]string

The credentials are provided as extra attributes that are lazy loaded. To request it, just set extra_fields[servers]=credentials in the query string.

page[size]integer

Number of items to return per page

page[number]integer

Page number to return (starts at 1)

stats[total]string

Request aggregate stats in the response meta. Use count to get the total number of records, returned as meta.stats.total.count.

Response

Success