The Server Resource

There are two parts to infrastructure on Cycle:

  1. The servers deployed to your hub.
  2. The list of available servers and their locations, available from our providers.

This server resource, refers to a server you have deployed to Cycle

For more information on infrastructure, see the main docs.

Attributes
  • id
    string

    The ID of the server.

  • hostname
    string

    The hostname used to identify this server.

  • creator
    object
    includable

    A creator object. Describes who created the resource.

    Show child fields
  • hub_id
    string

    The ID of the hub the server is associated with.

  • provider
    object

    Contains details regarding the provider the server is associated with.

    Show child fields
  • location_id
    string

    A Cycle-specific ID referencing the location/datacenter where this server exists. Cycle imports provider servers/locations and assigns them their own ID, which this field references.

  • model_id
    string

    A Cycle-specific ID referencing the model information for this server. Cycle imports provider servers/locations and assigns them their own ID, which this field references.

  • node_id
    string

    An identifier used internally by Cycle to identify a system running the Cycle agent.

  • cluster
    string

    The cluster this server is associated with (i.e. production, dev, etc).

  • features
    object

    Features of the server that can be turned on or off using boolean values.

    Show child fields
  • constraints
    object

    Constraints associated with deployments to this server.

    Show child fields
  • state
    object

    Information regarding the current state of the server.

    Show child fields
  • events
    object

    A collection of timestamps for each event in the server's lifetime.

    Show child fields
  • meta
    object
    optional

    A list of meta fields that can be applied to this server. See the meta section for more details.

    Show child fields
Example Server
{
"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"
}
}
}