The Container Instance Resource

Attributes
  • id
    string

    The ID of the instance.

  • creator
    object
    includable

    A creator object. Describes who created the resource.

    Show child fields
  • hub_id
    string

    The ID of the hub the instance is associated with.

  • container_id
    string

    The ID of the container the instance is associated with.

  • location_id
    string

    The ID of the location where the instance is deployed.

  • environment
    object

    Information about the environment that this instance is deployed to.

    Show child fields
  • stateful
    object | null

    Information pertaining to the instance's "statefulness".

    Show child fields
  • provider
    object

    Information about the provider this instance is deployed to.

    Show child fields
  • server_id
    string

    The ID of the server this instance is deployed to.

  • ready_state
    string

    The instance status:

    • active: This instance can be started or stopped.
    • purge: This instance should be deleted.
    • hibernate: This instance is active but not allowed to run.

  • hostname
    string

    The hostname of the instance.

  • migration
    object

    If this instance is scheduled to be migrated or has been migrated in the past, there will be information populating this field with the server that the instance came from or the server that the instance was moved to and the instance ID.

    Show child fields
  • purge_time
    string

    If an instance has been successfully migrated a purge time stamp will be created. This purge time is set to be 24 hours from the initial migration and signifies that Cycle will purge this instance at that time.

  • service
    string | null

    The service type of the instance, if any. Otherwise will return null.discovery | vpn | vpn-login-agent

  • state
    object

    Information regarding the current state of the instance.

    Show child fields
  • events
    object

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

    Show child fields
Example Instance
{
"id": "5cc78aa0db2ab000014a8b98",
"creator": {
"id": "5a232a77b6393d0001ac2df2",
"type": "account"
},
"hub_id": "5ccc2a2226393d1231eb4abd",
"container_id": "5cc78a8adb2ab000014a8b8a",
"location_id": "5c1ab90821638910ec95558a",
"environment": {
"id": "5cc78a8a4146380001c5b21f",
"subnet": "1",
"mac_addr": "00-15-E9-2B-99-3C",
"ipv6": {
"ip": "fd00::425e:eaec:1:1",
"cidr": "fd00::425e:eaec:1:1/112"
},
"legacy": {
"host": 22,
"ipv4": {
"ip": "10.183.47.22",
"cidr": "10.183.47.22/16"
},
"subnet": 1
}
},
"stateful": null,
"provider": {
"identifier": "equinix-metal",
"location": "2b70eb8f-fa18-47c0-aba7-222a842362fd"
},
"server_id": "5a14de0a78ecdb000128b9ec",
"ready_state": "active",
"hostname": "web",
"migration": {
"to": {
"instance_id": "5a14de0a78ecdb000128b9ec",
"server_id": "5a14de0a78ecdb000128b9ec"
},
"from": {
"instance_id": "5a14de0a78ecdb000128b9ec",
"server_id": "5a14de0a78ecdb000128b9ec"
},
"key": "5cc78aa0db2ab000014a8b98",
"copy_volumes": false
},
"purge_time": "2019-04-29T23:37:04.571Z",
"service": null,
"state": {
"changed": "2019-06-18T04:49:55.522Z",
"current": "running",
"health": {
"healthy": true,
"updated": "2021-04-29T23:37:04.571Z"
}
},
"events": {
"created": "2019-04-29T23:37:04.571Z",
"updated": "0001-01-01T00:00:00Z",
"deleted": "0001-01-01T00:00:00Z",
"first_started": "0001-01-01T00:00:00Z"
},
"includes": {
"containers": {
"5555cb8b5e411200014aaccd": {
"id": "5555cb8b5e411200014aaccd",
"name": "demoname",
"identifier": "demoname",
"creator": {
"id": "5a232a77b6393d0001ac2df2",
"type": "account"
},
"environment": {
"id": "5555cb655e411200014aaccd",
"cluster": "production",
"container_subnet": "3a5b",
"ipv6": {
"ip": "fd00::3f39:3a5b:0:0",
"cidr": "fd00::3f39:3a5b:0:0/96"
},
"legacy": null
},
"hub_id": "5ccc2a2226393d1231eb4abd",
"image": {
"id": "5b9c2a77b6393d0001eb45fd",
"service": null
},
"config": {
"network": {
"public": "egress-only",
"hostname": "demoname"
},
"deploy": {
"instances": 1,
"constraints": {
"node": {
"tags": {
"all": [
"vultr"
]
}
}
}
},
"integrations": {
"lets_encrypt": {
"enable": false
}
}
},
"instances": 3,
"stateful": false,
"role": null,
"annotations": {},
"state": {
"changed": "2021-01-22T16:15:18.69Z",
"current": "running",
"desired": "running"
},
"events": {
"created": "2020-11-16T18:57:15.243Z",
"updated": "0001-01-01T00:00:00Z",
"deleted": "0001-01-01T00:00:00Z",
"started": "2021-01-22T16:15:18.648Z"
}
}
},
"environments": {
"5555cb655e411200014aaccd": {
"id": "5555cb655e411200014aaccd",
"name": "Test DNS",
"about": {
"description": "",
"favorite": false
},
"creator": {
"id": "5a232a77b6393d0001ac2df2",
"type": "account"
},
"hub_id": "5ccc2a2226393d1231eb4abd",
"state": {
"changed": "2020-11-16T18:56:40.599Z",
"current": "live"
},
"cluster": "production",
"events": {
"created": "2020-11-16T18:56:37.398Z",
"updated": "0001-01-01T00:00:00Z",
"deleted": "0001-01-01T00:00:00Z"
},
"stack": null,
"features": {
"legacy_networking": false
},
"services": {
"discovery": {
"enable": true,
"container_id": "5555cb65dc380600013aaccd",
"high_availability": false,
"config": null
},
"vpn": {
"enable": false,
"container_id": "5555cb66dc380600013aaccd",
"high_availability": false,
"config": null
},
"loadbalancer": {
"enable": false,
"container_id": "5555cb68dc380600013aaccd",
"high_availability": false,
"config": null
}
},
"private_network": {
"vxlan_tag": 32537,
"subnet": "993f",
"ipv6": {
"ip": "fd00::993f:0:0:0",
"cidr": "fd00::993f:0:0:0/80"
},
"legacy": null
}
}
},
"locations": {
"666658f54938523a9e33aabb": {
"id": "666658f54938523a9e33aabb",
"name": "Silicon Valley, CA",
"geographic": {
"latitude": 0,
"longitude": 0,
"city": "",
"state": "CA",
"country": "US",
"region": "North America"
},
"provider": {
"identifier": "vultr",
"location": "12",
"code": "sjc"
},
"compatible": true,
"features": {
"available": [],
"supported": []
},
"abbreviation": "sjc",
"annotations": {}
}
},
"providers": {
"vultr": {
"id": "5b9c2a77b6393d0001eb45fd",
"name": "Vultr",
"identifier": "vultr",
"website": "https://vultr.com",
"required_fields": {
"api_key": {
"caption": "API Key",
"regex": "^([a-zA-Z0-9]{36})$"
}
},
"features": [
"Virtual Machines",
"IPv4",
"IPv6"
]
}
},
"servers": {
"7458267b4146380001eedeee": {
"id": "7458267b4146380001eedeee",
"hostname": "wjpxx-vultr-sjc.s.6223ddd8b6393d00019711aa.cycle.io",
"creator": {
"id": "5a232a77b6393d0001ac2df2",
"type": "account"
},
"hub_id": "5ccc2a2226393d1231eb4abd",
"provider": {
"identifier": "vultr",
"model": "202",
"location": "12",
"server": "23603322",
"init_ips": [
"45.33.4.133",
"2001:19f0:aaa1:2229:3300:01aa:fef7:5526"
]
},
"location_id": "666658f54938523a9e33aabb",
"cluster": "production",
"features": {
"sftp": true,
"base_volume_gb": null
},
"constraints": {
"tags": [
"vultr",
"vultr-sjc",
"test",
"apitest",
"nosftp"
],
"allow": {
"overcommit": true,
"pool": true,
"services": true
}
},
"model_id": "5b9c2a77b6393d0001eb45fd",
"node_id": "5b9c2a77b6393d0001eb45fd",
"state": {
"changed": "2019-03-25T00:54:19.877Z",
"current": "live"
},
"events": {
"created": "2019-03-25T00:53:15.202Z",
"updated": "2020-07-16T17:56:19.181Z",
"deleted": "0001-01-01T00:00:00Z",
"provisioning": {
"started": "0001-01-01T00:00:00Z",
"completed": "0001-01-01T00:00:00Z"
}
}
}
}
}
}