Cycle Docs | API Reference | List Provider Servers

List Provider Servers

Fetch the list of server models available to be deployed on Cycle that are associated with the specified provider.

query

meta

Accepted Values: locations
sort

Sorts can be performed on any field - see sorting
filter

Collections of resources can be filtered based on certain criteria - see filtering

Returns

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

The Provider Server Resource

id
string
The ID of the provider.
name
string
The name of this provider server.
description
string
A description provided by the provider for this server.
specs
object
Detailed breakdown of the server's specs
Show child fields
provider
object
Information about the provider this server is associated with.
Show child fields
price
object
An object detailing the price of this server.
Show child fields
compatible
bool
Whether this server is compatible with Cycle or not.
low_resource
bool
If true, this server has limited resources and should only be used for lightweight applications.
location_ids
array of strings
An array of Cycle specific IDs referencing the locations this server is available in.
features
object
A list of features this particular server type has available.
Show child fields

GET /v1/infrastructure/providers/{identifier}/servers

Example Request

$ curl https://api.cycle.io/v1/infrastructure/providers/equinix-metal/servers \
  -H "Authorization: Bearer API_KEY"
 \
  -H "X-Hub-Id: HUB_ID"

Example Response

{
  "data": [
    {
      "id": "5c2133bf21638910ec9f2320",
      "name": "t1.small.x86",
      "description": "",
      "specs": {
        "cpus": [
          {
            "count": 1,
            "type": "Intel Atom C2550 @ 2.4Ghz"
          }
        ],
        "memory": {
          "size_gb": 8,
          "type": "Physical"
        },
        "storage": [
          {
            "count": 1,
            "size_gb": 80,
            "type": "Physical (SSD)"
          }
        ],
        "network": [
          {
            "count": 2,
            "scope": "shared",
            "type": "Physical (Bonded)",
            "throughput_mbps": 1000
          }
        ],
        "features": {
          "raid": null
        }
      },
      "provider": {
        "identifier": "equinix-metal",
        "category": "baremetal",
        "class": "t1.small.x86",
        "model": "e69c0169-4726-46ea-98f1-939c9e8a3607",
        "locations": [
          "8e6470b3-b75e-47d1-bb93-45b225750975",
          "2b70eb8f-fa18-47c0-aba7-222a842362fd",
          "8ea03255-89f9-4e62-9d3f-8817db82ceed",
          "e1e9c52e-a0bc-4117-b996-0fc94843ea09"
        ]
      },
      "location_ids": [
        "5c1ab90921638910ec955599",
        "5c1ab90821638910ec95558a",
        "5c1ab90921638910ec955593",
        "5c1ab90821638910ec95558d"
      ],
      "price": {
        "mills": 50400,
        "term": "monthly"
      },
      "compatible": true,
      "low_resource": false
    }
  ]
}