List Servers

Fetch a list of servers that have been deployed to your hub.

If you include the stats meta it will only be updated once per minute.

Requires the servers-view permission.

query
  • include

    Includes can any of the following: locationsmodelsproviders

  • meta

    Metas can be any of the following: nodecounts

  • sort

    Sorts can be performed on any field.

  • filter

    Filters can be any of the following: tags

Returns

Returns a list of server resources, otherwise returns an Error.

GET /v1/infrastructure/servers

Example Request
$ curl https://api.cycle.io/v1/infrastructure/servers \
-H
"Authorization: Bearer API_KEY"
\
-H
"X-Hub-Id: HUB_ID"
Example Response
{
"data": [
{
"id": "5dd333ee4146380001d9e3b5",
"hostname": "rjxxd-packet-sjc1.s.5d798d1a414638000157d0f0.cycle.io",
"owner": {
"id": "5bac2478b6393d0001f21aad",
"type": "account"
},
"hub_id": "5d792342314638000157d0f0",
"provider": {
"identifier": "packet",
"model": "e6934169-4726-46ea-98f1-939c9e8a3607",
"location": "2b234b8f-fa18-47c0-aba7-222a842362fd",
"server": "033bdaea-9b71-47fc-b2e1-e5307a7d33bb"
},
"location_id": "5c1ab55521638910ec95558a",
"cluster": "production",
"features": {
"sftp": true
},
"constraints": {
"tags": [
"packet",
"packet-sjc1",
"packet-t1.small.x86",
"packet-general"
],
"allow": {
"pool": true,
"overcommit": true,
"services": true
}
},
"model_id": "5c2133bf21638910ec9f2320",
"node_id": "5dd844464c51ea00019644b0",
"state": {
"changed": "2019-11-22T18:11:57.507Z",
"current": "provisioning"
},
"events": {
"created": "2019-11-22T18:11:58.087Z",
"updated": "0001-01-01T00:00:00Z",
"deleted": "0001-01-01T00:00:00Z",
"provisioning": {
"started": "0001-01-01T00:00:00Z",
"completed": "0001-01-01T00:00:00Z"
}
}
}
]
}