Add Servers

Use this API call to add new infrastructure to your hub.

Requires the servers-provision permission.

Arguments
  • servers
    array of objects

    An array of objects describing servers you wish to add to your hub.

    Show child fields
  • cluster
    string

    The cluster this server should be associated with, e.g.production.

Returns

Returns a server resource, otherwise returns an Error.

POST /v1/infrastructure/servers

Example Request
# This will deploy a Equinix Metal t1.small.x86 in Sunnyvale, CA
$ curl https://api.cycle.io/v1/infrastructure/servers/5dd333ee4146380001d9e3b5 \
  -H 
"Authorization: Bearer API_KEY"
 \
  -H 
"X-Hub-Id: HUB_ID"
 \
  -H 'Content-Type: application/json'
  -d '{"cluster":"production","servers":[{"provider":"equinix-metal","model_id":"5c2133bf21638910ec9f2320","location_id":"5c1ab90821638910ec95558a","quantity":1}]}'
  -X POST
Example Response
{
  "data": {
    "id": "5dd333ee4146380001d9e3b5",
    "hostname": "rjxxd-equinix-sjc1.s.5d798d1a414638000157d0f0.cycle.io",
    "creator": {
      "id": "5bac2478b6393d0001f21aad",
      "type": "account"
    },
    "hub_id": "5d792342314638000157d0f0",
    "provider": {
      "identifier": "equinix-metal",
      "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,
      "base_volume_gb": 30
    },
    "constraints": {
      "tags": [
        "equinix",
        "equinix-sjc1",
        "equinix-t1.small.x86",
        "equinix-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"
      }
    }
  }
}