Instances

Endpoints related to managing a container's instances, including connecting to the console and credentials for SSH.

List Instances

Requires the containers-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId

required

string

The ID of the container this instance is created from.

query Parameters

include	Array of strings A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. Items Enum: "creators" "servers" "locations" "integrations" "containers" "environments"
	object Filter Field The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
sort	Array of strings An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	object In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`

Responses

200

Returns a list of Container Instances.

default

General error response from the platform

get/v1/containers/{containerId}/instances

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"container_id": "string",
"location_id": "string",
"environment": {"id": "651586fca6078e98982dbd90",
"network_subnet": "string",
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"host": 0,
"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
},
"mac_addr": "string",
"vxlan_tag": 0
},
"stateful": {"id": "651586fca6078e98982dbd90",
"base_hostname": "string"
},
"function": {"seed": 0
},
"provider": {"vendor": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string"
},
"server_id": "651586fca6078e98982dbd90",
"ready_state": "active",
"purge_time": "2021-01-30T08:30:00Z",
"hostname": "string",
"service": "discovery",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"autoscale": {"min_ttl": "2021-01-30T08:30:00Z"
},
"migration": {"to": {"instance_id": "string",
"server_id": "string"
},
"from": {"instance_id": "string",
"server_id": "string"
},
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z",
"key": "string",
"copy_volumes": true
},
"deployment": {"version": "v1.2.3-dev"
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
}
],
"includes": {"creators": {"accounts": {"property1": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
},
"property2": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
},
"employees": null,
"visitors": null,
"environments": null,
"api_keys": null
},
"servers": {"property1": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"location_id": "string",
"model_id": "string",
"node_id": "string",
"shared_file_systems": {"mounts": {"property1": {"type": "string",
"options": "key1=value1,key2=value2",
"source": "string"
},
"property2": {"type": "string",
"options": "key1=value1,key2=value2",
"source": "string"
}
},
"directories": {"property1": null,
"property2": null
}
},
"hostname": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"provider": {"vendor": "string",
"model": "string",
"location": "string",
"server": "string",
"init_ips": ["string"
],
"mac_addr": "string",
"extra": { },
"provision_options": {"attachesd_storage_size": 0,
"reservation_id": "string"
}
},
"cluster": "string",
"features": {"sftp": true,
"base_volume_gb": 0
},
"constraints": {"tags": ["string"
],
"allow": {"pool": true,
"services": true,
"overcommit": true
}
},
"autoscale": {"group_id": "651586fca6078e98982dbd90"
},
"ephemeral": true,
"evacuate": {"started": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"latest_instance": "2021-01-30T08:30:00Z",
"provisioning": {"started": "2021-01-30T08:30:00Z",
"failed": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
},
"meta": {"node": {"last_checkin": "2021-01-30T08:30:00Z",
"drivers": ["string"
],
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
},
"stats": {"network": {"interfaces": { },
"external_ipv4": null,
"external_ipv6": null
},
"uptime": {"seconds": null,
"cpu_idle": null
},
"cpu": {"cores": null,
"processors": [ ],
"usage": null
},
"load": {"avg1m": null,
"avg5m": null,
"avg15m": null
},
"ram": {"available": null,
"free": null,
"total": null
},
"storage": {"volume_groups": { },
"mounts": { }
},
"os": {"release": null,
"kernel": null,
"hostname": null
},
"versions": {"services": { }
}
},
"healthy": true,
"online": true
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"location_id": "string",
"model_id": "string",
"node_id": "string",
"shared_file_systems": {"mounts": {"property1": {"type": "string",
"options": "key1=value1,key2=value2",
"source": "string"
},
"property2": {"type": "string",
"options": "key1=value1,key2=value2",
"source": "string"
}
},
"directories": {"property1": null,
"property2": null
}
},
"hostname": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"provider": {"vendor": "string",
"model": "string",
"location": "string",
"server": "string",
"init_ips": ["string"
],
"mac_addr": "string",
"extra": { },
"provision_options": {"attachesd_storage_size": 0,
"reservation_id": "string"
}
},
"cluster": "string",
"features": {"sftp": true,
"base_volume_gb": 0
},
"constraints": {"tags": ["string"
],
"allow": {"pool": true,
"services": true,
"overcommit": true
}
},
"autoscale": {"group_id": "651586fca6078e98982dbd90"
},
"ephemeral": true,
"evacuate": {"started": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"latest_instance": "2021-01-30T08:30:00Z",
"provisioning": {"started": "2021-01-30T08:30:00Z",
"failed": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
},
"meta": {"node": {"last_checkin": "2021-01-30T08:30:00Z",
"drivers": ["string"
],
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
},
"stats": {"network": {"interfaces": { },
"external_ipv4": null,
"external_ipv6": null
},
"uptime": {"seconds": null,
"cpu_idle": null
},
"cpu": {"cores": null,
"processors": [ ],
"usage": null
},
"load": {"avg1m": null,
"avg5m": null,
"avg15m": null
},
"ram": {"available": null,
"free": null,
"total": null
},
"storage": {"volume_groups": { },
"mounts": { }
},
"os": {"release": null,
"kernel": null,
"hostname": null
},
"versions": {"services": { }
}
},
"healthy": true,
"online": true
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
},
"locations": {"property1": {"id": "string",
"name": "string",
"geographic": {"latitude": 0,
"longitude": 0,
"city": "string",
"state": "string",
"country": "string",
"region": "string"
},
"provider": {"identifier": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string",
"code": "string",
"availability_zones": ["string"
]
},
"compatible": true,
"features": {"available": ["string"
],
"supported": ["string"
]
},
"abbreviation": "string",
"annotations": {"property1": null,
"property2": null
}
},
"property2": {"id": "string",
"name": "string",
"geographic": {"latitude": 0,
"longitude": 0,
"city": "string",
"state": "string",
"country": "string",
"region": "string"
},
"provider": {"identifier": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string",
"code": "string",
"availability_zones": ["string"
]
},
"compatible": true,
"features": {"available": ["string"
],
"supported": ["string"
]
},
"abbreviation": "string",
"annotations": {"property1": null,
"property2": null
}
}
},
"integrations": {"property1": {"id": "651586fca6078e98982dbd90",
"name": "string",
"vendor": "string",
"identifier": "string",
"auth": {"region": "string",
"namespace": "string",
"api_key": "string",
"key_id": "string",
"secret": "string",
"subscription_id": "string",
"client_id": "string",
"base64_config": "string"
},
"extra": {"property1": "string",
"property2": "string"
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"meta": {"definition": {"vendor": "string",
"name": "string",
"supports_verification": true,
"supports_multiple": true,
"features": ["string"
],
"extends": ["string"
],
"extended_configuration": {"options": [{ }
]
},
"fields": {"extra": {"property1": { },
"property2": { }
},
"auth": {"property1": { },
"property2": { }
}
},
"url": "http://example.com",
"public": true,
"usable": true,
"editable": true
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"name": "string",
"vendor": "string",
"identifier": "string",
"auth": {"region": "string",
"namespace": "string",
"api_key": "string",
"key_id": "string",
"secret": "string",
"subscription_id": "string",
"client_id": "string",
"base64_config": "string"
},
"extra": {"property1": "string",
"property2": "string"
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"meta": {"definition": {"vendor": "string",
"name": "string",
"supports_verification": true,
"supports_multiple": true,
"features": ["string"
],
"extends": ["string"
],
"extended_configuration": {"options": [{ }
]
},
"fields": {"extra": {"property1": { },
"property2": { }
},
"auth": {"property1": { },
"property2": { }
}
},
"url": "http://example.com",
"public": true,
"usable": true,
"editable": true
}
}
}
},
"integrations:identifiers": {"property1": ["651586fca6078e98982dbd90"
],
"property2": ["651586fca6078e98982dbd90"
]
},
"containers": {"property1": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"environment": {"id": "651586fca6078e98982dbd90",
"cluster": "string",
"container_subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"hub_id": "651586fca6078e98982dbd90",
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "string"
},
"service": "discovery"
},
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": ["string"
]
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": 0,
"max_shard_concurrency": 0,
"max_runtime": "72h45m2s",
"max_queue_time": "72h45m2s"
},
"stateful": {"options": {"use_base_hostname": null
}
},
"constraints": {"node": {"tags": { }
},
"secrets": [null
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": [null
]
},
"startup": {"delay": "72h45m2s"
},
"update": {"stagger": "72h45m2s"
},
"restart": {"condition": "always",
"delay": "72h45m2s",
"max_attempts": 0
},
"health_check": {"command": "string",
"retries": 0,
"delay": "72h45m2s",
"interval": "72h45m2s",
"timeout": "72h45m2s",
"restart": true
},
"telemetry": {"retention": "72h45m2s",
"interval": "72h45m2s",
"disable": true
}
},
"scale": {"autoscale_group": "string",
"instances": {"max": 0,
"max_server": 0,
"min_ttl": "72h45m2s"
},
"window": "72h45m2s",
"thresholds": [{"type": null,
"details": { }
}
]
},
"runtime": {"command": {"path": "string",
"args": "string"
},
"namespaces": ["ipc"
],
"environment_vars": {"property1": "string",
"property2": "string"
},
"privileged": true,
"capabilities": ["CAP_CHOWN"
],
"workdir": "string",
"sysctl": {"property1": "string",
"property2": "string"
},
"rlimits": {"property1": {"hard": null,
"soft": null
},
"property2": {"hard": null,
"soft": null
}
},
"seccomp": {"disable": true,
"rules": [null
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M, 128M, 512M"
}
},
"resources": {"cpu": {"shares": {"limit": null,
"reserve": null
},
"cpus": "string"
},
"ram": {"limit": "1G, 2M",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": null,
"start": null,
"stop": null
},
"config": "string"
},
"files": [{"source": null,
"destination": null
}
],
"lets_encrypt": {"enable": true,
"certificate_path": "string",
"chain_path": "string",
"key_path": "string",
"bundle_path": "string",
"additional_certs_path": "string"
},
"backups": {"integration_id": "my-image-source",
"backup": {"command": null,
"timeout": null,
"cron_string": null
},
"restore": {"command": null,
"timeout": null
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": null,
"mount_point": null
},
"property2": {"writable": null,
"mount_point": null
}
},
"logs": {"groups": [null
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"config": {"read_only": true,
"local": {"max_size": null,
"storage_pool": null
},
"destination": "string",
"remote_access": {"enable": null,
"ips": [ ],
"webhook": null,
"password": { }
}
}
}
],
"annotations": {"property1": null,
"property2": null
},
"role": "orchestrator",
"stateful": true,
"deprecate": true,
"lock": true,
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"started": "2021-01-30T08:30:00Z"
},
"meta": {"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"domains": [{"fqdn": "string",
"record": {"id": null,
"hub_id": null,
"creator": null,
"zone_id": null,
"name": null,
"resolved_domain": null,
"type": null,
"features": { },
"state": null,
"events": null
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": null,
"instance_id": null,
"environment_id": null
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": null,
"error": { }
}
}
]
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"environment": {"id": "651586fca6078e98982dbd90",
"cluster": "string",
"container_subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"hub_id": "651586fca6078e98982dbd90",
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "string"
},
"service": "discovery"
},
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": ["string"
]
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": 0,
"max_shard_concurrency": 0,
"max_runtime": "72h45m2s",
"max_queue_time": "72h45m2s"
},
"stateful": {"options": {"use_base_hostname": null
}
},
"constraints": {"node": {"tags": { }
},
"secrets": [null
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": [null
]
},
"startup": {"delay": "72h45m2s"
},
"update": {"stagger": "72h45m2s"
},
"restart": {"condition": "always",
"delay": "72h45m2s",
"max_attempts": 0
},
"health_check": {"command": "string",
"retries": 0,
"delay": "72h45m2s",
"interval": "72h45m2s",
"timeout": "72h45m2s",
"restart": true
},
"telemetry": {"retention": "72h45m2s",
"interval": "72h45m2s",
"disable": true
}
},
"scale": {"autoscale_group": "string",
"instances": {"max": 0,
"max_server": 0,
"min_ttl": "72h45m2s"
},
"window": "72h45m2s",
"thresholds": [{"type": null,
"details": { }
}
]
},
"runtime": {"command": {"path": "string",
"args": "string"
},
"namespaces": ["ipc"
],
"environment_vars": {"property1": "string",
"property2": "string"
},
"privileged": true,
"capabilities": ["CAP_CHOWN"
],
"workdir": "string",
"sysctl": {"property1": "string",
"property2": "string"
},
"rlimits": {"property1": {"hard": null,
"soft": null
},
"property2": {"hard": null,
"soft": null
}
},
"seccomp": {"disable": true,
"rules": [null
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M, 128M, 512M"
}
},
"resources": {"cpu": {"shares": {"limit": null,
"reserve": null
},
"cpus": "string"
},
"ram": {"limit": "1G, 2M",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": null,
"start": null,
"stop": null
},
"config": "string"
},
"files": [{"source": null,
"destination": null
}
],
"lets_encrypt": {"enable": true,
"certificate_path": "string",
"chain_path": "string",
"key_path": "string",
"bundle_path": "string",
"additional_certs_path": "string"
},
"backups": {"integration_id": "my-image-source",
"backup": {"command": null,
"timeout": null,
"cron_string": null
},
"restore": {"command": null,
"timeout": null
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": null,
"mount_point": null
},
"property2": {"writable": null,
"mount_point": null
}
},
"logs": {"groups": [null
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"config": {"read_only": true,
"local": {"max_size": null,
"storage_pool": null
},
"destination": "string",
"remote_access": {"enable": null,
"ips": [ ],
"webhook": null,
"password": { }
}
}
}
],
"annotations": {"property1": null,
"property2": null
},
"role": "orchestrator",
"stateful": true,
"deprecate": true,
"lock": true,
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"started": "2021-01-30T08:30:00Z"
},
"meta": {"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"domains": [{"fqdn": "string",
"record": {"id": null,
"hub_id": null,
"creator": null,
"zone_id": null,
"name": null,
"resolved_domain": null,
"type": null,
"features": { },
"state": null,
"events": null
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": null,
"instance_id": null,
"environment_id": null
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": null,
"error": { }
}
}
]
}
}
},
"containers:identifiers": {"property1": ["651586fca6078e98982dbd90"
],
"property2": ["651586fca6078e98982dbd90"
]
},
"environments": {"property1": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"cluster": "string",
"about": {"description": "string",
"favorite": true
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"features": {"legacy_networking": true,
"monitoring": {"tier": "limited"
}
},
"services": {"loadbalancer": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"ipv4": true,
"ipv6": true,
"type": "v1",
"details": {"controllers": [ ],
"controller_template": null,
"waf": null
},
"bind_host": true
}
},
"discovery": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"empty_set_delay": "72h45m2s",
"hosts": {"property1": { },
"property2": { }
}
}
},
"vpn": {"enable": true,
"container_id": "string",
"auto_update": true,
"config": {"allow_internet": true,
"auth": {"webhook": null,
"cycle_accounts": null,
"vpn_accounts": null
}
}
},
"scheduler": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"public": true,
"access_keys": [null
]
}
}
},
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"private_network": {"vxlan_tag": 0,
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"deployments": {"tags": {"property1": "v1.2.3-dev",
"property2": "v1.2.3-dev"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"containers": [{"id": "651586fca6078e98982dbd90",
"name": "string",
"state": {"changed": null,
"error": { }
},
"image": {"id": null,
"service": null
},
"environment": {"id": null,
"cluster": null,
"container_subnet": null,
"ipv6": null,
"legacy": null
}
}
]
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"cluster": "string",
"about": {"description": "string",
"favorite": true
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"features": {"legacy_networking": true,
"monitoring": {"tier": "limited"
}
},
"services": {"loadbalancer": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"ipv4": true,
"ipv6": true,
"type": "v1",
"details": {"controllers": [ ],
"controller_template": null,
"waf": null
},
"bind_host": true
}
},
"discovery": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"empty_set_delay": "72h45m2s",
"hosts": {"property1": { },
"property2": { }
}
}
},
"vpn": {"enable": true,
"container_id": "string",
"auto_update": true,
"config": {"allow_internet": true,
"auth": {"webhook": null,
"cycle_accounts": null,
"vpn_accounts": null
}
}
},
"scheduler": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"public": true,
"access_keys": [null
]
}
}
},
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"private_network": {"vxlan_tag": 0,
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"deployments": {"tags": {"property1": "v1.2.3-dev",
"property2": "v1.2.3-dev"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"containers": [{"id": "651586fca6078e98982dbd90",
"name": "string",
"state": {"changed": null,
"error": { }
},
"image": {"id": null,
"service": null
},
"environment": {"id": null,
"cluster": null,
"container_subnet": null,
"ipv6": null,
"legacy": null
}
}
]
}
}
},
"environments:identifiers": {"property1": ["651586fca6078e98982dbd90"
],
"property2": ["651586fca6078e98982dbd90"
]
}
}
}

Create Instances

Manually create Instances of a Container.

Requires the containers-update capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId

required

string

The ID of the Container this Instance is created from.

Request Body schema: application/json

Array

server_id required	string The ID of the Server the new Instance(s) should be deployed to.
new_instances required	integer The number of new Instances to be created on the given Server.

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/containers/{containerId}/instances

Request samples

Payload

application/json

[{"server_id": "string",
"new_instances": 0
}
]

Response samples

202
default

application/json

{"data": {"action": "string",
"job": {"id": "string",
"accepted": true,
"queue": "string",
"schedule": "2021-01-30T08:30:00Z",
"parallel": {"sub_queue": "string",
"tasks": true
},
"tasks": [{"caption": "string",
"header": "string",
"steps": [{"caption": "string",
"description": "string",
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
],
"input": {"property1": null,
"property2": null
}
}
]
}
}
}

Delete Container Instance(s)

Manually delete Instances of a Container.

Requires the containers-update capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId

required

string

The ID of the container the instance(s) were created from.

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/containers/{containerId}/instances

Response samples

202
default

application/json

{"data": {"action": "string",
"job": {"id": "string",
"accepted": true,
"queue": "string",
"schedule": "2021-01-30T08:30:00Z",
"parallel": {"sub_queue": "string",
"tasks": true
},
"tasks": [{"caption": "string",
"header": "string",
"steps": [{"caption": "string",
"description": "string",
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
],
"input": {"property1": null,
"property2": null
}
}
]
}
}
}

Get Instance

Requires the containers-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId required	string The ID of the requested container.
instanceId required	string The ID for the container instance.

query Parameters

include

Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "creators" "servers" "locations" "integrations" "containers" "environments"

Responses

200

Returns a Container Instance.

default

General error response from the platform

get/v1/containers/{containerId}/instances/{instanceId}

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"container_id": "string",
"location_id": "string",
"environment": {"id": "651586fca6078e98982dbd90",
"network_subnet": "string",
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"host": 0,
"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
},
"mac_addr": "string",
"vxlan_tag": 0
},
"stateful": {"id": "651586fca6078e98982dbd90",
"base_hostname": "string"
},
"function": {"seed": 0
},
"provider": {"vendor": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string"
},
"server_id": "651586fca6078e98982dbd90",
"ready_state": "active",
"purge_time": "2021-01-30T08:30:00Z",
"hostname": "string",
"service": "discovery",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"autoscale": {"min_ttl": "2021-01-30T08:30:00Z"
},
"migration": {"to": {"instance_id": "string",
"server_id": "string"
},
"from": {"instance_id": "string",
"server_id": "string"
},
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z",
"key": "string",
"copy_volumes": true
},
"deployment": {"version": "v1.2.3-dev"
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
},
"includes": {"creators": {"accounts": {"property1": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
},
"property2": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
},
"employees": null,
"visitors": null,
"environments": null,
"api_keys": null
},
"servers": {"property1": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"location_id": "string",
"model_id": "string",
"node_id": "string",
"shared_file_systems": {"mounts": {"property1": {"type": "string",
"options": "key1=value1,key2=value2",
"source": "string"
},
"property2": {"type": "string",
"options": "key1=value1,key2=value2",
"source": "string"
}
},
"directories": {"property1": null,
"property2": null
}
},
"hostname": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"provider": {"vendor": "string",
"model": "string",
"location": "string",
"server": "string",
"init_ips": ["string"
],
"mac_addr": "string",
"extra": { },
"provision_options": {"attachesd_storage_size": 0,
"reservation_id": "string"
}
},
"cluster": "string",
"features": {"sftp": true,
"base_volume_gb": 0
},
"constraints": {"tags": ["string"
],
"allow": {"pool": true,
"services": true,
"overcommit": true
}
},
"autoscale": {"group_id": "651586fca6078e98982dbd90"
},
"ephemeral": true,
"evacuate": {"started": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"latest_instance": "2021-01-30T08:30:00Z",
"provisioning": {"started": "2021-01-30T08:30:00Z",
"failed": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
},
"meta": {"node": {"last_checkin": "2021-01-30T08:30:00Z",
"drivers": ["string"
],
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
},
"stats": {"network": {"interfaces": { },
"external_ipv4": null,
"external_ipv6": null
},
"uptime": {"seconds": null,
"cpu_idle": null
},
"cpu": {"cores": null,
"processors": [ ],
"usage": null
},
"load": {"avg1m": null,
"avg5m": null,
"avg15m": null
},
"ram": {"available": null,
"free": null,
"total": null
},
"storage": {"volume_groups": { },
"mounts": { }
},
"os": {"release": null,
"kernel": null,
"hostname": null
},
"versions": {"services": { }
}
},
"healthy": true,
"online": true
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"location_id": "string",
"model_id": "string",
"node_id": "string",
"shared_file_systems": {"mounts": {"property1": {"type": "string",
"options": "key1=value1,key2=value2",
"source": "string"
},
"property2": {"type": "string",
"options": "key1=value1,key2=value2",
"source": "string"
}
},
"directories": {"property1": null,
"property2": null
}
},
"hostname": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"provider": {"vendor": "string",
"model": "string",
"location": "string",
"server": "string",
"init_ips": ["string"
],
"mac_addr": "string",
"extra": { },
"provision_options": {"attachesd_storage_size": 0,
"reservation_id": "string"
}
},
"cluster": "string",
"features": {"sftp": true,
"base_volume_gb": 0
},
"constraints": {"tags": ["string"
],
"allow": {"pool": true,
"services": true,
"overcommit": true
}
},
"autoscale": {"group_id": "651586fca6078e98982dbd90"
},
"ephemeral": true,
"evacuate": {"started": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"latest_instance": "2021-01-30T08:30:00Z",
"provisioning": {"started": "2021-01-30T08:30:00Z",
"failed": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
},
"meta": {"node": {"last_checkin": "2021-01-30T08:30:00Z",
"drivers": ["string"
],
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
},
"stats": {"network": {"interfaces": { },
"external_ipv4": null,
"external_ipv6": null
},
"uptime": {"seconds": null,
"cpu_idle": null
},
"cpu": {"cores": null,
"processors": [ ],
"usage": null
},
"load": {"avg1m": null,
"avg5m": null,
"avg15m": null
},
"ram": {"available": null,
"free": null,
"total": null
},
"storage": {"volume_groups": { },
"mounts": { }
},
"os": {"release": null,
"kernel": null,
"hostname": null
},
"versions": {"services": { }
}
},
"healthy": true,
"online": true
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
},
"locations": {"property1": {"id": "string",
"name": "string",
"geographic": {"latitude": 0,
"longitude": 0,
"city": "string",
"state": "string",
"country": "string",
"region": "string"
},
"provider": {"identifier": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string",
"code": "string",
"availability_zones": ["string"
]
},
"compatible": true,
"features": {"available": ["string"
],
"supported": ["string"
]
},
"abbreviation": "string",
"annotations": {"property1": null,
"property2": null
}
},
"property2": {"id": "string",
"name": "string",
"geographic": {"latitude": 0,
"longitude": 0,
"city": "string",
"state": "string",
"country": "string",
"region": "string"
},
"provider": {"identifier": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string",
"code": "string",
"availability_zones": ["string"
]
},
"compatible": true,
"features": {"available": ["string"
],
"supported": ["string"
]
},
"abbreviation": "string",
"annotations": {"property1": null,
"property2": null
}
}
},
"integrations": {"property1": {"id": "651586fca6078e98982dbd90",
"name": "string",
"vendor": "string",
"identifier": "string",
"auth": {"region": "string",
"namespace": "string",
"api_key": "string",
"key_id": "string",
"secret": "string",
"subscription_id": "string",
"client_id": "string",
"base64_config": "string"
},
"extra": {"property1": "string",
"property2": "string"
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"meta": {"definition": {"vendor": "string",
"name": "string",
"supports_verification": true,
"supports_multiple": true,
"features": ["string"
],
"extends": ["string"
],
"extended_configuration": {"options": [{ }
]
},
"fields": {"extra": {"property1": { },
"property2": { }
},
"auth": {"property1": { },
"property2": { }
}
},
"url": "http://example.com",
"public": true,
"usable": true,
"editable": true
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"name": "string",
"vendor": "string",
"identifier": "string",
"auth": {"region": "string",
"namespace": "string",
"api_key": "string",
"key_id": "string",
"secret": "string",
"subscription_id": "string",
"client_id": "string",
"base64_config": "string"
},
"extra": {"property1": "string",
"property2": "string"
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"meta": {"definition": {"vendor": "string",
"name": "string",
"supports_verification": true,
"supports_multiple": true,
"features": ["string"
],
"extends": ["string"
],
"extended_configuration": {"options": [{ }
]
},
"fields": {"extra": {"property1": { },
"property2": { }
},
"auth": {"property1": { },
"property2": { }
}
},
"url": "http://example.com",
"public": true,
"usable": true,
"editable": true
}
}
}
},
"integrations:identifiers": {"property1": ["651586fca6078e98982dbd90"
],
"property2": ["651586fca6078e98982dbd90"
]
},
"containers": {"property1": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"environment": {"id": "651586fca6078e98982dbd90",
"cluster": "string",
"container_subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"hub_id": "651586fca6078e98982dbd90",
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "string"
},
"service": "discovery"
},
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": ["string"
]
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": 0,
"max_shard_concurrency": 0,
"max_runtime": "72h45m2s",
"max_queue_time": "72h45m2s"
},
"stateful": {"options": {"use_base_hostname": null
}
},
"constraints": {"node": {"tags": { }
},
"secrets": [null
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": [null
]
},
"startup": {"delay": "72h45m2s"
},
"update": {"stagger": "72h45m2s"
},
"restart": {"condition": "always",
"delay": "72h45m2s",
"max_attempts": 0
},
"health_check": {"command": "string",
"retries": 0,
"delay": "72h45m2s",
"interval": "72h45m2s",
"timeout": "72h45m2s",
"restart": true
},
"telemetry": {"retention": "72h45m2s",
"interval": "72h45m2s",
"disable": true
}
},
"scale": {"autoscale_group": "string",
"instances": {"max": 0,
"max_server": 0,
"min_ttl": "72h45m2s"
},
"window": "72h45m2s",
"thresholds": [{"type": null,
"details": { }
}
]
},
"runtime": {"command": {"path": "string",
"args": "string"
},
"namespaces": ["ipc"
],
"environment_vars": {"property1": "string",
"property2": "string"
},
"privileged": true,
"capabilities": ["CAP_CHOWN"
],
"workdir": "string",
"sysctl": {"property1": "string",
"property2": "string"
},
"rlimits": {"property1": {"hard": null,
"soft": null
},
"property2": {"hard": null,
"soft": null
}
},
"seccomp": {"disable": true,
"rules": [null
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M, 128M, 512M"
}
},
"resources": {"cpu": {"shares": {"limit": null,
"reserve": null
},
"cpus": "string"
},
"ram": {"limit": "1G, 2M",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": null,
"start": null,
"stop": null
},
"config": "string"
},
"files": [{"source": null,
"destination": null
}
],
"lets_encrypt": {"enable": true,
"certificate_path": "string",
"chain_path": "string",
"key_path": "string",
"bundle_path": "string",
"additional_certs_path": "string"
},
"backups": {"integration_id": "my-image-source",
"backup": {"command": null,
"timeout": null,
"cron_string": null
},
"restore": {"command": null,
"timeout": null
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": null,
"mount_point": null
},
"property2": {"writable": null,
"mount_point": null
}
},
"logs": {"groups": [null
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"config": {"read_only": true,
"local": {"max_size": null,
"storage_pool": null
},
"destination": "string",
"remote_access": {"enable": null,
"ips": [ ],
"webhook": null,
"password": { }
}
}
}
],
"annotations": {"property1": null,
"property2": null
},
"role": "orchestrator",
"stateful": true,
"deprecate": true,
"lock": true,
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"started": "2021-01-30T08:30:00Z"
},
"meta": {"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"domains": [{"fqdn": "string",
"record": {"id": null,
"hub_id": null,
"creator": null,
"zone_id": null,
"name": null,
"resolved_domain": null,
"type": null,
"features": { },
"state": null,
"events": null
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": null,
"instance_id": null,
"environment_id": null
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": null,
"error": { }
}
}
]
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"environment": {"id": "651586fca6078e98982dbd90",
"cluster": "string",
"container_subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"hub_id": "651586fca6078e98982dbd90",
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "string"
},
"service": "discovery"
},
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": ["string"
]
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": 0,
"max_shard_concurrency": 0,
"max_runtime": "72h45m2s",
"max_queue_time": "72h45m2s"
},
"stateful": {"options": {"use_base_hostname": null
}
},
"constraints": {"node": {"tags": { }
},
"secrets": [null
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": [null
]
},
"startup": {"delay": "72h45m2s"
},
"update": {"stagger": "72h45m2s"
},
"restart": {"condition": "always",
"delay": "72h45m2s",
"max_attempts": 0
},
"health_check": {"command": "string",
"retries": 0,
"delay": "72h45m2s",
"interval": "72h45m2s",
"timeout": "72h45m2s",
"restart": true
},
"telemetry": {"retention": "72h45m2s",
"interval": "72h45m2s",
"disable": true
}
},
"scale": {"autoscale_group": "string",
"instances": {"max": 0,
"max_server": 0,
"min_ttl": "72h45m2s"
},
"window": "72h45m2s",
"thresholds": [{"type": null,
"details": { }
}
]
},
"runtime": {"command": {"path": "string",
"args": "string"
},
"namespaces": ["ipc"
],
"environment_vars": {"property1": "string",
"property2": "string"
},
"privileged": true,
"capabilities": ["CAP_CHOWN"
],
"workdir": "string",
"sysctl": {"property1": "string",
"property2": "string"
},
"rlimits": {"property1": {"hard": null,
"soft": null
},
"property2": {"hard": null,
"soft": null
}
},
"seccomp": {"disable": true,
"rules": [null
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M, 128M, 512M"
}
},
"resources": {"cpu": {"shares": {"limit": null,
"reserve": null
},
"cpus": "string"
},
"ram": {"limit": "1G, 2M",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": null,
"start": null,
"stop": null
},
"config": "string"
},
"files": [{"source": null,
"destination": null
}
],
"lets_encrypt": {"enable": true,
"certificate_path": "string",
"chain_path": "string",
"key_path": "string",
"bundle_path": "string",
"additional_certs_path": "string"
},
"backups": {"integration_id": "my-image-source",
"backup": {"command": null,
"timeout": null,
"cron_string": null
},
"restore": {"command": null,
"timeout": null
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": null,
"mount_point": null
},
"property2": {"writable": null,
"mount_point": null
}
},
"logs": {"groups": [null
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"config": {"read_only": true,
"local": {"max_size": null,
"storage_pool": null
},
"destination": "string",
"remote_access": {"enable": null,
"ips": [ ],
"webhook": null,
"password": { }
}
}
}
],
"annotations": {"property1": null,
"property2": null
},
"role": "orchestrator",
"stateful": true,
"deprecate": true,
"lock": true,
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"started": "2021-01-30T08:30:00Z"
},
"meta": {"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"domains": [{"fqdn": "string",
"record": {"id": null,
"hub_id": null,
"creator": null,
"zone_id": null,
"name": null,
"resolved_domain": null,
"type": null,
"features": { },
"state": null,
"events": null
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": null,
"instance_id": null,
"environment_id": null
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": null,
"error": { }
}
}
]
}
}
},
"containers:identifiers": {"property1": ["651586fca6078e98982dbd90"
],
"property2": ["651586fca6078e98982dbd90"
]
},
"environments": {"property1": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"cluster": "string",
"about": {"description": "string",
"favorite": true
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"features": {"legacy_networking": true,
"monitoring": {"tier": "limited"
}
},
"services": {"loadbalancer": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"ipv4": true,
"ipv6": true,
"type": "v1",
"details": {"controllers": [ ],
"controller_template": null,
"waf": null
},
"bind_host": true
}
},
"discovery": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"empty_set_delay": "72h45m2s",
"hosts": {"property1": { },
"property2": { }
}
}
},
"vpn": {"enable": true,
"container_id": "string",
"auto_update": true,
"config": {"allow_internet": true,
"auth": {"webhook": null,
"cycle_accounts": null,
"vpn_accounts": null
}
}
},
"scheduler": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"public": true,
"access_keys": [null
]
}
}
},
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"private_network": {"vxlan_tag": 0,
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"deployments": {"tags": {"property1": "v1.2.3-dev",
"property2": "v1.2.3-dev"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"containers": [{"id": "651586fca6078e98982dbd90",
"name": "string",
"state": {"changed": null,
"error": { }
},
"image": {"id": null,
"service": null
},
"environment": {"id": null,
"cluster": null,
"container_subnet": null,
"ipv6": null,
"legacy": null
}
}
]
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"cluster": "string",
"about": {"description": "string",
"favorite": true
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"features": {"legacy_networking": true,
"monitoring": {"tier": "limited"
}
},
"services": {"loadbalancer": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"ipv4": true,
"ipv6": true,
"type": "v1",
"details": {"controllers": [ ],
"controller_template": null,
"waf": null
},
"bind_host": true
}
},
"discovery": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"empty_set_delay": "72h45m2s",
"hosts": {"property1": { },
"property2": { }
}
}
},
"vpn": {"enable": true,
"container_id": "string",
"auto_update": true,
"config": {"allow_internet": true,
"auth": {"webhook": null,
"cycle_accounts": null,
"vpn_accounts": null
}
}
},
"scheduler": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"public": true,
"access_keys": [null
]
}
}
},
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"private_network": {"vxlan_tag": 0,
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"deployments": {"tags": {"property1": "v1.2.3-dev",
"property2": "v1.2.3-dev"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"containers": [{"id": "651586fca6078e98982dbd90",
"name": "string",
"state": {"changed": null,
"error": { }
},
"image": {"id": null,
"service": null
},
"environment": {"id": null,
"cluster": null,
"container_subnet": null,
"ipv6": null,
"legacy": null
}
}
]
}
}
},
"environments:identifiers": {"property1": ["651586fca6078e98982dbd90"
],
"property2": ["651586fca6078e98982dbd90"
]
}
}
}

Delete Container Instance

Requires the containers-update capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId required	string The ID of the requested container.
instanceId required	string The ID for the container instance.

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/containers/{containerId}/instances/{instanceId}

Response samples

202
default

application/json

{"data": {"action": "string",
"job": {"id": "string",
"accepted": true,
"queue": "string",
"schedule": "2021-01-30T08:30:00Z",
"parallel": {"sub_queue": "string",
"tasks": true
},
"tasks": [{"caption": "string",
"header": "string",
"steps": [{"caption": "string",
"description": "string",
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
],
"input": {"property1": null,
"property2": null
}
}
]
}
}
}

Generate Instance SSH Credentials

Generates credentials for connecting to an Instance via SSH. The generated endpoint/secret can be used to log in via SSH into the Instance without exposing ports on the container or host.

Requires the containers-ssh capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId required	string The ID of the requested container.
instanceId required	string The ID for the container instance.

Responses

200

Returns an SSH connection response.

default

General error response from the platform

get/v1/containers/{containerId}/instances/{instanceId}/ssh

Response samples

200
default

application/json

{"data": {"token": {"id": "651586fca6078e98982dbd90",
"instance_id": "string",
"container_id": "string",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"events": {"created": "2021-01-30T08:30:00Z",
"used": "2021-01-30T08:30:00Z",
"expires": "2021-01-30T08:30:00Z"
},
"valid": true
},
"secret": "string",
"address": "string"
}
}

Expire SSH Credentials

Instantly expires any SSH credentials generated for this Instance.

Requires the containers-ssh capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId required	string The ID of the requested container.
instanceId required	string The ID for the container instance.

Responses

200

Returns the number of tokens removed.

default

General error response from the platform

delete/v1/containers/{containerId}/instances/{instanceId}/ssh

Response samples

200
default

application/json

{"data": {"tokens": 0
}
}

Create Instance Job

Used to perform different actions on a given Container Instance. Can be used to migrate or undo a migration of a Container Instance.

Requires the containers-instance-migrate capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId required	string The ID of the requested container.
instanceId required	string The ID for the container instance.

Request Body schema: application/json

Parameters for creating a new container instance job.

action required	string The name of the action to perform. migrate
required	object

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/containers/{containerId}/instances/{instanceId}/tasks

Request samples

Payload

application/json

{"action": "migrate",
"contents": {"destination_server_id": "string",
"stateful": {"copy_volumes": true
}
}
}

Response samples

202
default

application/json

{"data": {"action": "string",
"job": {"id": "string",
"accepted": true,
"queue": "string",
"schedule": "2021-01-30T08:30:00Z",
"parallel": {"sub_queue": "string",
"tasks": true
},
"tasks": [{"caption": "string",
"header": "string",
"steps": [{"caption": "string",
"description": "string",
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
],
"input": {"property1": null,
"property2": null
}
}
]
}
}
}

List Instance Volumes

Requires the containers-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId required	string The ID of the requested Container.
instanceId required	string The ID for the Container Instance.

query Parameters

sort	Array of strings An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	object In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`

Responses

200

Returns a list of Container Instance Volumes.

default

General error response from the platform

get/v1/containers/{containerId}/instances/{instanceId}/volumes

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"config": {"read_only": true,
"local": {"max_size": "10G",
"storage_pool": true
},
"destination": "string",
"remote_access": {"enable": true,
"ips": ["string"
],
"webhook": "string",
"password": {"algorithm": "raw",
"data": "string"
}
}
},
"deployed": {"server_id": "string",
"container_id": "string",
"container_volume_id": "string",
"instance_id": "string",
"hash": "string",
"path": "string",
"storage": {"used": 0,
"total": 0
}
},
"sftp": {"host": "string",
"port": 0,
"username": "string",
"password": {"algorithm": "raw",
"data": "string"
}
}
}
]
}

Get Instance Telemetry Report

Retrieves a point-in-time report of an Instance's resource usage (CPU, RAM, Network, Storage, etc).

Requires the containers-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId required	string The ID of the requested container.
instanceId required	string The ID for the container instance.

query Parameters

object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

Responses

200

Returns an Instance telemetry report.

default

General error response from the platform

get/v1/containers/{containerId}/instances/{instanceId}/telemetry/resources/report

Response samples

200
default

application/json

{"data": {"request": {"instance_id": "string",
"start": "2021-01-30T08:30:00Z",
"end": "2021-01-30T08:30:00Z"
},
"snapshots": [{"time": "2021-01-30T08:30:00Z",
"hub_id": "651586fca6078e98982dbd90",
"container_id": "651586fca6078e98982dbd90",
"instance_id": "651586fca6078e98982dbd90",
"environment_id": "651586fca6078e98982dbd90",
"server_id": "651586fca6078e98982dbd90",
"cluster": "string",
"cpu": {"usage": {"total": 0,
"per_core": [0
],
"kernel": 0,
"user": 0
},
"throttling": {"periods": 0,
"throttled_periods": 0,
"throttled_time": 0
}
},
"memory": {"cache": 0,
"usage": {"usage": 0,
"max_usage": 0,
"fail_count": 0,
"limit": 0
},
"swap_usage": {"usage": 0,
"max_usage": 0,
"fail_count": 0,
"limit": 0
},
"kernel_usage": {"usage": 0,
"max_usage": 0,
"fail_count": 0,
"limit": 0
},
"kernel_tcp_usage": {"usage": 0,
"max_usage": 0,
"fail_count": 0,
"limit": 0
}
},
"processes": {"current": 0,
"limit": 0
},
"network": {"interfaces": [{"name": "string",
"rx_bytes": 0,
"tx_bytes": 0
}
]
},
"hugetlb": {"usage": 0,
"max": 0,
"fail_count": 0
}
}
]
}
}

Instance Telemetry Stream Authorization

Retrieves an access token and URL to open a websocket to for streaming instance telemetry live. This connects directly to the compute layer on the server the instance is hosted on, and streams telemetry in real time.

Requires the containers-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId required	string The ID of the requested container.
instanceId required	string The ID for the Container Instance.

Responses

200

Returns credentials for connecting to an instance telemetry stream.

default

General error response from the platform

get/v1/containers/{containerId}/instances/{instanceId}/telemetry/resources/stream

Response samples

200
default

application/json

{"data": {"token": "string",
"address": "string"
}
}

Instance Console Stream Authorization

Returns the authorization information necessary to connect to a Container Instance's console. To connect via WebSocket, use the returned address, and append the returned token as a URL parameter: <address>?token=<token>.

Requires the containers-console capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId required	string The ID for the Container
instanceId required	string The ID of the Instance.

Responses

200

Returns authorization information necessary for accessing a Container Instance's console.

default

General error response from the platform

get/v1/containers/{containerId}/instances/{instanceId}/console

Response samples

200
default

application/json

{"data": {"token": "string",
"address": "string"
}
}

➔ Next to Backups