Containers

Endpoints related to managing containers, such as starting/stopping/reconfiguring and telemetry.

List Containers

Requires the containers-view capability.

SecuritybearerAuth and hubAuth

Request

query Parameters

meta	Array of strings A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. Items Enum: "instances_count" "domains" "ips"
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" "images" "stack_builds" "stacks" "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 Containers.

default

General error response from the platform

get/v1/containers

Response samples

200
default

application/json

{"data": [{"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": true
}
},
"constraints": {"node": {"tags": {"any": [ ],
"all": [ ]
}
},
"secrets": ["string"
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": ["SIGTERM"
]
},
"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": "ram",
"details": {"usage": null
}
}
]
},
"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": 0,
"soft": 0
},
"property2": {"hard": 0,
"soft": 0
}
},
"seccomp": {"disable": true,
"rules": [{"capabilities": { },
"syscall": { }
}
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M, 128M, 512M"
}
},
"resources": {"cpu": {"shares": {"limit": 0,
"reserve": 0
},
"cpus": "string"
},
"ram": {"limit": "1G, 2M",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": "string",
"start": "string",
"stop": "string"
},
"config": "string"
},
"files": [{"source": "string",
"destination": "string"
}
],
"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": "string",
"timeout": "72h45m2s",
"cron_string": "string"
},
"restore": {"command": "string",
"timeout": "72h45m2s"
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": true,
"mount_point": "string"
},
"property2": {"writable": true,
"mount_point": "string"
}
},
"logs": {"groups": ["string"
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"config": {"read_only": true,
"local": {"max_size": "10G",
"storage_pool": true
},
"destination": "string",
"remote_access": {"enable": true,
"ips": [null
],
"webhook": "string",
"password": {"algorithm": null,
"data": null
}
}
}
}
],
"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": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": null,
"type": null
},
"zone_id": "string",
"name": "string",
"resolved_domain": "string",
"type": {"a": { },
"aaaa": { },
"cname": { },
"ns": { },
"mx": { },
"txt": { },
"alias": { },
"srv": { },
"caa": { },
"linked": { }
},
"features": {"certificate": null
},
"state": {"changed": null,
"error": { }
},
"events": {"property1": null,
"property2": null
}
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": "string",
"instance_id": "string",
"environment_id": "string"
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
}
}
]
}
}
],
"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
},
"images": {"property1": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"name": "string",
"size": 0,
"about": {"description": "string"
},
"backend": {"provider": "string",
"size": 0,
"file_name": "string",
"file_id": "string"
},
"requires": {"nvidia_gpu": true
},
"build": {"args": {"property1": "string",
"property2": "string"
}
},
"builder": {"integration_id": "651586fca6078e98982dbd90"
},
"config": {"user": "string",
"ports": [{"host": 0,
"container": 0,
"type": "string"
}
],
"env": {"property1": "string",
"property2": "string"
},
"labels": {"property1": "string",
"property2": "string"
},
"command": ["string"
],
"entrypoint": ["string"
],
"volumes": [{"path": "string",
"mode": "ro"
}
],
"workdir": "string",
"signal_stop": "string"
},
"source": {"type": "direct",
"details": {"id": "string",
"origin": {"type": "docker-hub",
"details": {"existing": null,
"target": null,
"username": null,
"token": null
}
}
},
"override": {"target": "string",
"targz_url": "string"
}
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"factory": {"node_id": "string",
"cached": "2021-01-30T08:30:00Z",
"acknowledged": "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"
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"name": "string",
"size": 0,
"about": {"description": "string"
},
"backend": {"provider": "string",
"size": 0,
"file_name": "string",
"file_id": "string"
},
"requires": {"nvidia_gpu": true
},
"build": {"args": {"property1": "string",
"property2": "string"
}
},
"builder": {"integration_id": "651586fca6078e98982dbd90"
},
"config": {"user": "string",
"ports": [{"host": 0,
"container": 0,
"type": "string"
}
],
"env": {"property1": "string",
"property2": "string"
},
"labels": {"property1": "string",
"property2": "string"
},
"command": ["string"
],
"entrypoint": ["string"
],
"volumes": [{"path": "string",
"mode": "ro"
}
],
"workdir": "string",
"signal_stop": "string"
},
"source": {"type": "direct",
"details": {"id": "string",
"origin": {"type": "docker-hub",
"details": {"existing": null,
"target": null,
"username": null,
"token": null
}
}
},
"override": {"target": "string",
"targz_url": "string"
}
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"factory": {"node_id": "string",
"cached": "2021-01-30T08:30:00Z",
"acknowledged": "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"
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
},
"stack_builds": {"property1": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"stack_id": "string",
"spec": {"version": "1.0",
"about": {"version": "string",
"description": "string"
},
"scoped_variables": [{"identifier": "string",
"scope": {"containers": { }
},
"access": {"env_variable": { },
"internal_api": { },
"file": { }
},
"source": { }
}
],
"containers": {"property1": {"name": "string",
"image": {"name": null,
"origin": null,
"build": { },
"builder": { }
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": null,
"deploy": null,
"scaling": null,
"runtime": null,
"resources": null,
"integrations": null
},
"role": "conductor",
"volumes": [null
],
"deprecate": true,
"lock": true
},
"property2": {"name": "string",
"image": {"name": null,
"origin": null,
"build": { },
"builder": { }
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": null,
"deploy": null,
"scaling": null,
"runtime": null,
"resources": null,
"integrations": null
},
"role": "conductor",
"volumes": [null
],
"deprecate": true,
"lock": true
}
},
"services": {"discovery": { },
"loadbalancer": { },
"scheduler": { },
"vpn": { }
},
"annotations": {"property1": null,
"property2": null
}
},
"about": {"version": "string",
"description": "string",
"git_commit": {"hash": "string",
"message": "string",
"time": "2021-01-30T08:30:00Z",
"author": {"name": "string",
"email": "string"
}
}
},
"instructions": {"git": {"type": "hash",
"value": "string"
},
"variables": {"property1": "string",
"property2": "string"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"stack_id": "string",
"spec": {"version": "1.0",
"about": {"version": "string",
"description": "string"
},
"scoped_variables": [{"identifier": "string",
"scope": {"containers": { }
},
"access": {"env_variable": { },
"internal_api": { },
"file": { }
},
"source": { }
}
],
"containers": {"property1": {"name": "string",
"image": {"name": null,
"origin": null,
"build": { },
"builder": { }
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": null,
"deploy": null,
"scaling": null,
"runtime": null,
"resources": null,
"integrations": null
},
"role": "conductor",
"volumes": [null
],
"deprecate": true,
"lock": true
},
"property2": {"name": "string",
"image": {"name": null,
"origin": null,
"build": { },
"builder": { }
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": null,
"deploy": null,
"scaling": null,
"runtime": null,
"resources": null,
"integrations": null
},
"role": "conductor",
"volumes": [null
],
"deprecate": true,
"lock": true
}
},
"services": {"discovery": { },
"loadbalancer": { },
"scheduler": { },
"vpn": { }
},
"annotations": {"property1": null,
"property2": null
}
},
"about": {"version": "string",
"description": "string",
"git_commit": {"hash": "string",
"message": "string",
"time": "2021-01-30T08:30:00Z",
"author": {"name": "string",
"email": "string"
}
}
},
"instructions": {"git": {"type": "hash",
"value": "string"
},
"variables": {"property1": "string",
"property2": "string"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
},
"stacks": {"property1": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"type": "account",
"id": "651586fca6078e98982dbd90"
},
"source": {"type": "git-repo",
"details": {"stack_file": "string",
"url": "string",
"branch": "string",
"auth": {"type": "http",
"credentials": {"username": null,
"password": null
}
},
"ref": {"type": "string",
"value": "string"
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"variables": {"property1": "string",
"property2": "string"
},
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_build": "2021-01-30T08:30:00Z"
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"builds_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"type": "account",
"id": "651586fca6078e98982dbd90"
},
"source": {"type": "git-repo",
"details": {"stack_file": "string",
"url": "string",
"branch": "string",
"auth": {"type": "http",
"credentials": {"username": null,
"password": null
}
},
"ref": {"type": "string",
"value": "string"
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"variables": {"property1": "string",
"property2": "string"
},
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_build": "2021-01-30T08:30:00Z"
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"builds_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
},
"stacks: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 Container

Requires the containers-deploy capability.

SecuritybearerAuth and hubAuth

Request

Request Body schema: application/json

Parameters for creating a new Container.

name required	string A user defined name for the Container.
	Identifier (string) or null
environment_id required	string An identifier for the Environment this Container will be deployed to.
image_id required	string An identifier for the Image used to create this Container.
stateful required	boolean A boolean where true represents this Container is stateful.
required	object (Config) A container configuration.
lock	boolean When set to true, prevents this Container from being deleted.
	Deployment (object) or null
	Array of objects (ContainerVolume)
	object or null Custom meta data. Not utilized by Cycle.

Responses

201

Returns a Container.

default

General error response from the platform

post/v1/containers

Request samples

Payload

application/json

{"name": "string",
"identifier": "string",
"environment_id": "string",
"image_id": "string",
"stateful": true,
"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": true
}
},
"constraints": {"node": {"tags": {"any": ["string"
],
"all": ["string"
]
}
},
"secrets": ["string"
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": ["SIGTERM"
]
},
"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": "ram",
"details": {"usage": "2G"
}
}
]
},
"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": 0,
"soft": 0
},
"property2": {"hard": 0,
"soft": 0
}
},
"seccomp": {"disable": true,
"rules": [{"capabilities": {"includes": "string",
"excludes": "string"
},
"syscall": {"names": [null
],
"action": "string",
"errnoRet": 0,
"args": [{ }
]
}
}
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M, 128M, 512M"
}
},
"resources": {"cpu": {"shares": {"limit": 0,
"reserve": 0
},
"cpus": "string"
},
"ram": {"limit": "1G, 2M",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": "string",
"start": "string",
"stop": "string"
},
"config": "string"
},
"files": [{"source": "string",
"destination": "string"
}
],
"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": "string",
"timeout": "72h45m2s",
"cron_string": "string"
},
"restore": {"command": "string",
"timeout": "72h45m2s"
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": true,
"mount_point": "string"
},
"property2": {"writable": true,
"mount_point": "string"
}
},
"logs": {"groups": ["string"
]
}
}
},
"lock": true,
"deployment": {"version": "v1.2.3-dev"
},
"volumes": [{"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"
}
}
}
],
"annotations": {"property1": null,
"property2": null
}
}

Response samples

201
default

application/json

{"data": {"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": true
}
},
"constraints": {"node": {"tags": {"any": [null
],
"all": [null
]
}
},
"secrets": ["string"
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": ["SIGTERM"
]
},
"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": "ram",
"details": {"usage": "2G"
}
}
]
},
"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": 0,
"soft": 0
},
"property2": {"hard": 0,
"soft": 0
}
},
"seccomp": {"disable": true,
"rules": [{"capabilities": {"includes": null,
"excludes": null
},
"syscall": {"names": [ ],
"action": null,
"errnoRet": null,
"args": [ ]
}
}
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M, 128M, 512M"
}
},
"resources": {"cpu": {"shares": {"limit": 0,
"reserve": 0
},
"cpus": "string"
},
"ram": {"limit": "1G, 2M",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": "string",
"start": "string",
"stop": "string"
},
"config": "string"
},
"files": [{"source": "string",
"destination": "string"
}
],
"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": "string",
"timeout": "72h45m2s",
"cron_string": "string"
},
"restore": {"command": "string",
"timeout": "72h45m2s"
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": true,
"mount_point": "string"
},
"property2": {"writable": true,
"mount_point": "string"
}
},
"logs": {"groups": ["string"
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"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"
}
}
}
}
],
"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": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"zone_id": "string",
"name": "string",
"resolved_domain": "string",
"type": {"a": {"ip": null
},
"aaaa": {"ip": null
},
"cname": {"domain": null
},
"ns": {"domain": null
},
"mx": {"priority": null,
"domain": null
},
"txt": {"value": null
},
"alias": {"domain": null
},
"srv": {"weight": null,
"priority": null,
"port": null,
"domain": null
},
"caa": {"tag": null,
"value": null
},
"linked": {"features": { },
"container_id": null
}
},
"features": {"certificate": {"id": null,
"generated": null,
"wildcard_child": null
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
},
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
}
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": "string",
"instance_id": "string",
"environment_id": "string"
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
]
}
}
}

Get Container

Gets a Container.

Requires the containers-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId

required

string

The ID of the requested Container.

query Parameters

meta

Array of strings

A comma separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

Items Enum: "instances_count" "domains" "ips"

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" "images" "stack_builds" "stacks" "environments"

Responses

200

Returns a Container.

default

General error response from the platform

get/v1/containers/{containerId}

Response samples

200
default

application/json

{"data": {"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": true
}
},
"constraints": {"node": {"tags": {"any": [null
],
"all": [null
]
}
},
"secrets": ["string"
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": ["SIGTERM"
]
},
"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": "ram",
"details": {"usage": "2G"
}
}
]
},
"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": 0,
"soft": 0
},
"property2": {"hard": 0,
"soft": 0
}
},
"seccomp": {"disable": true,
"rules": [{"capabilities": {"includes": null,
"excludes": null
},
"syscall": {"names": [ ],
"action": null,
"errnoRet": null,
"args": [ ]
}
}
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M, 128M, 512M"
}
},
"resources": {"cpu": {"shares": {"limit": 0,
"reserve": 0
},
"cpus": "string"
},
"ram": {"limit": "1G, 2M",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": "string",
"start": "string",
"stop": "string"
},
"config": "string"
},
"files": [{"source": "string",
"destination": "string"
}
],
"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": "string",
"timeout": "72h45m2s",
"cron_string": "string"
},
"restore": {"command": "string",
"timeout": "72h45m2s"
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": true,
"mount_point": "string"
},
"property2": {"writable": true,
"mount_point": "string"
}
},
"logs": {"groups": ["string"
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"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"
}
}
}
}
],
"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": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"zone_id": "string",
"name": "string",
"resolved_domain": "string",
"type": {"a": {"ip": null
},
"aaaa": {"ip": null
},
"cname": {"domain": null
},
"ns": {"domain": null
},
"mx": {"priority": null,
"domain": null
},
"txt": {"value": null
},
"alias": {"domain": null
},
"srv": {"weight": null,
"priority": null,
"port": null,
"domain": null
},
"caa": {"tag": null,
"value": null
},
"linked": {"features": { },
"container_id": null
}
},
"features": {"certificate": {"id": null,
"generated": null,
"wildcard_child": null
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
},
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
}
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": "string",
"instance_id": "string",
"environment_id": "string"
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "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
},
"images": {"property1": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"name": "string",
"size": 0,
"about": {"description": "string"
},
"backend": {"provider": "string",
"size": 0,
"file_name": "string",
"file_id": "string"
},
"requires": {"nvidia_gpu": true
},
"build": {"args": {"property1": "string",
"property2": "string"
}
},
"builder": {"integration_id": "651586fca6078e98982dbd90"
},
"config": {"user": "string",
"ports": [{"host": 0,
"container": 0,
"type": "string"
}
],
"env": {"property1": "string",
"property2": "string"
},
"labels": {"property1": "string",
"property2": "string"
},
"command": ["string"
],
"entrypoint": ["string"
],
"volumes": [{"path": "string",
"mode": "ro"
}
],
"workdir": "string",
"signal_stop": "string"
},
"source": {"type": "direct",
"details": {"id": "string",
"origin": {"type": "docker-hub",
"details": {"existing": null,
"target": null,
"username": null,
"token": null
}
}
},
"override": {"target": "string",
"targz_url": "string"
}
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"factory": {"node_id": "string",
"cached": "2021-01-30T08:30:00Z",
"acknowledged": "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"
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"name": "string",
"size": 0,
"about": {"description": "string"
},
"backend": {"provider": "string",
"size": 0,
"file_name": "string",
"file_id": "string"
},
"requires": {"nvidia_gpu": true
},
"build": {"args": {"property1": "string",
"property2": "string"
}
},
"builder": {"integration_id": "651586fca6078e98982dbd90"
},
"config": {"user": "string",
"ports": [{"host": 0,
"container": 0,
"type": "string"
}
],
"env": {"property1": "string",
"property2": "string"
},
"labels": {"property1": "string",
"property2": "string"
},
"command": ["string"
],
"entrypoint": ["string"
],
"volumes": [{"path": "string",
"mode": "ro"
}
],
"workdir": "string",
"signal_stop": "string"
},
"source": {"type": "direct",
"details": {"id": "string",
"origin": {"type": "docker-hub",
"details": {"existing": null,
"target": null,
"username": null,
"token": null
}
}
},
"override": {"target": "string",
"targz_url": "string"
}
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"factory": {"node_id": "string",
"cached": "2021-01-30T08:30:00Z",
"acknowledged": "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"
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
},
"stack_builds": {"property1": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"stack_id": "string",
"spec": {"version": "1.0",
"about": {"version": "string",
"description": "string"
},
"scoped_variables": [{"identifier": "string",
"scope": {"containers": { }
},
"access": {"env_variable": { },
"internal_api": { },
"file": { }
},
"source": { }
}
],
"containers": {"property1": {"name": "string",
"image": {"name": null,
"origin": null,
"build": { },
"builder": { }
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": null,
"deploy": null,
"scaling": null,
"runtime": null,
"resources": null,
"integrations": null
},
"role": "conductor",
"volumes": [null
],
"deprecate": true,
"lock": true
},
"property2": {"name": "string",
"image": {"name": null,
"origin": null,
"build": { },
"builder": { }
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": null,
"deploy": null,
"scaling": null,
"runtime": null,
"resources": null,
"integrations": null
},
"role": "conductor",
"volumes": [null
],
"deprecate": true,
"lock": true
}
},
"services": {"discovery": { },
"loadbalancer": { },
"scheduler": { },
"vpn": { }
},
"annotations": {"property1": null,
"property2": null
}
},
"about": {"version": "string",
"description": "string",
"git_commit": {"hash": "string",
"message": "string",
"time": "2021-01-30T08:30:00Z",
"author": {"name": "string",
"email": "string"
}
}
},
"instructions": {"git": {"type": "hash",
"value": "string"
},
"variables": {"property1": "string",
"property2": "string"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"stack_id": "string",
"spec": {"version": "1.0",
"about": {"version": "string",
"description": "string"
},
"scoped_variables": [{"identifier": "string",
"scope": {"containers": { }
},
"access": {"env_variable": { },
"internal_api": { },
"file": { }
},
"source": { }
}
],
"containers": {"property1": {"name": "string",
"image": {"name": null,
"origin": null,
"build": { },
"builder": { }
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": null,
"deploy": null,
"scaling": null,
"runtime": null,
"resources": null,
"integrations": null
},
"role": "conductor",
"volumes": [null
],
"deprecate": true,
"lock": true
},
"property2": {"name": "string",
"image": {"name": null,
"origin": null,
"build": { },
"builder": { }
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": null,
"deploy": null,
"scaling": null,
"runtime": null,
"resources": null,
"integrations": null
},
"role": "conductor",
"volumes": [null
],
"deprecate": true,
"lock": true
}
},
"services": {"discovery": { },
"loadbalancer": { },
"scheduler": { },
"vpn": { }
},
"annotations": {"property1": null,
"property2": null
}
},
"about": {"version": "string",
"description": "string",
"git_commit": {"hash": "string",
"message": "string",
"time": "2021-01-30T08:30:00Z",
"author": {"name": "string",
"email": "string"
}
}
},
"instructions": {"git": {"type": "hash",
"value": "string"
},
"variables": {"property1": "string",
"property2": "string"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
},
"stacks": {"property1": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"type": "account",
"id": "651586fca6078e98982dbd90"
},
"source": {"type": "git-repo",
"details": {"stack_file": "string",
"url": "string",
"branch": "string",
"auth": {"type": "http",
"credentials": {"username": null,
"password": null
}
},
"ref": {"type": "string",
"value": "string"
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"variables": {"property1": "string",
"property2": "string"
},
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_build": "2021-01-30T08:30:00Z"
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"builds_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"type": "account",
"id": "651586fca6078e98982dbd90"
},
"source": {"type": "git-repo",
"details": {"stack_file": "string",
"url": "string",
"branch": "string",
"auth": {"type": "http",
"credentials": {"username": null,
"password": null
}
},
"ref": {"type": "string",
"value": "string"
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"variables": {"property1": "string",
"property2": "string"
},
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_build": "2021-01-30T08:30:00Z"
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"builds_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
},
"stacks: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"
]
}
}
}

Update Container

Updates the specified Container.

Requires the containers-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId

required

string

The ID of the Container.

Request Body schema: application/json

Parameters for updating a Container.

name	string The name for the Container.
identifier	string The name for the identifier.
deprecate	boolean Sets whether Container should be deprecated.
lock	boolean When set to true, prevents this Container from being deleted.
	object User meta data for the Container.

Responses

200

Returns the updated Container.

default

General error response from the platform

patch/v1/containers/{containerId}

Request samples

Payload

application/json

{"name": "string",
"identifier": "string",
"deprecate": true,
"lock": true,
"annotation": {"property1": "string",
"property2": "string"
}
}

Response samples

200
default

application/json

{"data": {"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": true
}
},
"constraints": {"node": {"tags": {"any": [null
],
"all": [null
]
}
},
"secrets": ["string"
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": ["SIGTERM"
]
},
"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": "ram",
"details": {"usage": "2G"
}
}
]
},
"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": 0,
"soft": 0
},
"property2": {"hard": 0,
"soft": 0
}
},
"seccomp": {"disable": true,
"rules": [{"capabilities": {"includes": null,
"excludes": null
},
"syscall": {"names": [ ],
"action": null,
"errnoRet": null,
"args": [ ]
}
}
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M, 128M, 512M"
}
},
"resources": {"cpu": {"shares": {"limit": 0,
"reserve": 0
},
"cpus": "string"
},
"ram": {"limit": "1G, 2M",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": "string",
"start": "string",
"stop": "string"
},
"config": "string"
},
"files": [{"source": "string",
"destination": "string"
}
],
"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": "string",
"timeout": "72h45m2s",
"cron_string": "string"
},
"restore": {"command": "string",
"timeout": "72h45m2s"
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": true,
"mount_point": "string"
},
"property2": {"writable": true,
"mount_point": "string"
}
},
"logs": {"groups": ["string"
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"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"
}
}
}
}
],
"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": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"zone_id": "string",
"name": "string",
"resolved_domain": "string",
"type": {"a": {"ip": null
},
"aaaa": {"ip": null
},
"cname": {"domain": null
},
"ns": {"domain": null
},
"mx": {"priority": null,
"domain": null
},
"txt": {"value": null
},
"alias": {"domain": null
},
"srv": {"weight": null,
"priority": null,
"port": null,
"domain": null
},
"caa": {"tag": null,
"value": null
},
"linked": {"features": { },
"container_id": null
}
},
"features": {"certificate": {"id": null,
"generated": null,
"wildcard_child": null
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
},
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
}
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": "string",
"instance_id": "string",
"environment_id": "string"
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
]
}
}
}

Delete Container

Requires the containers-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId

required

string

The ID of the requested Container.

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/containers/{containerId}

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 Container Summary

Requires the containers-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId

required

string

The ID of the requested container.

Responses

200

Returns an Container summary resource.

default

General error response from the platform

get/v1/containers/{containerId}/summary

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"stats": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}

Create Container Job

Used to perform different actions on a given Container.

Requires the following capabilities based on the task: start: containers-manage stop: containers-manage reconfigure: containers-manage volumes.reconfigure: containers-volumes-manage reimage: containers-manage scale: containers-manage

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId

required

string

The ID of the requested container.

Request Body schema: application/json

Parameters for creating a new container job.

action

required

string

The name of the action to perform.

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/containers/{containerId}/tasks

Request samples

Payload

application/json

{"action": "start"
}

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 Container Servers

Lists all Servers that currently have an Instance of this Container deployed to them.

Requires the containers-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId

required

string

The ID of the requested container.

query Parameters

meta	Array of strings A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. Items Value: "primary_ip"
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 an array of Server IDs / number of Instances of this Container deployed to them.

default

General error response from the platform

get/v1/containers/{containerId}/servers

Response samples

200
default

application/json

{"data": {"server_id": "651586fca6078e98982dbd90",
"instances": 0
}
}

List Compatible Servers

Gets a list of servers that are compatible with the specified Container and its restrictions (tags, etc).

Requires the containers-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId

required

string

The ID of the requested container.

query Parameters

meta	Array of strings A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. Items Enum: "node" "instances_count"
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: "location" "models" "integrations"
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 Servers.

default

General error response from the platform

get/v1/containers/{containerId}/servers/usable

Response samples

200
default

application/json

{"data": [{"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": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"stats": {"network": {"interfaces": {"property1": { },
"property2": { }
},
"external_ipv4": "string",
"external_ipv6": "string"
},
"uptime": {"seconds": 0,
"cpu_idle": 0
},
"cpu": {"cores": 0,
"processors": [{ }
],
"usage": {"user": null,
"nice": null,
"system": null,
"idle": null,
"iowait": null,
"irq": null,
"soft_irq": null,
"steal": null,
"guest": null,
"guest_nice": null
}
},
"load": {"avg1m": 0,
"avg5m": 0,
"avg15m": 0
},
"ram": {"available": 0,
"free": 0,
"total": 0
},
"storage": {"volume_groups": {"property1": { },
"property2": { }
},
"mounts": {"property1": { },
"property2": { }
}
},
"os": {"release": "string",
"kernel": "string",
"hostname": "string"
},
"versions": {"services": {"property1": null,
"property2": null
}
}
},
"healthy": true,
"online": true
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
],
"includes": {"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
}
}
},
"models": {"property1": {"id": "651586fca6078e98982dbd90",
"name": "string",
"description": "string",
"specs": {"cpu": {"count": 0,
"cores": 0,
"threads": 0,
"type": "string",
"shared": true,
"extra": {"property1": "string",
"property2": "string"
}
},
"gpu": {"count": 0,
"cores": 0,
"vram_gb": 0,
"type": "string",
"shared": true,
"extra": {"property1": "string",
"property2": "string"
}
},
"memory": {"size_gb": 0,
"type": "string",
"extra": {"property1": "string",
"property2": "string"
}
},
"storage": [{"count": 0,
"size_gb": 0,
"type": "string",
"extra": {"property1": null,
"property2": null
}
}
],
"network": [{"count": 0,
"scope": "public",
"throughput": 0,
"type": "string"
}
],
"features": {"raid": "string",
"aws": {"ena_support": true,
"ebs_optimized": true
}
}
},
"provider": {"identifier": "string",
"integration_id": "651586fca6078e98982dbd90",
"category": "string",
"class": "string",
"model": "string",
"locations": ["string"
],
"availability_zones": {"property1": ["string"
],
"property2": ["string"
]
}
},
"price": {"mills": 0,
"term": "once"
},
"compatible": true,
"low_resource": true,
"location_ids": ["string"
]
},
"property2": {"id": "651586fca6078e98982dbd90",
"name": "string",
"description": "string",
"specs": {"cpu": {"count": 0,
"cores": 0,
"threads": 0,
"type": "string",
"shared": true,
"extra": {"property1": "string",
"property2": "string"
}
},
"gpu": {"count": 0,
"cores": 0,
"vram_gb": 0,
"type": "string",
"shared": true,
"extra": {"property1": "string",
"property2": "string"
}
},
"memory": {"size_gb": 0,
"type": "string",
"extra": {"property1": "string",
"property2": "string"
}
},
"storage": [{"count": 0,
"size_gb": 0,
"type": "string",
"extra": {"property1": null,
"property2": null
}
}
],
"network": [{"count": 0,
"scope": "public",
"throughput": 0,
"type": "string"
}
],
"features": {"raid": "string",
"aws": {"ena_support": true,
"ebs_optimized": true
}
}
},
"provider": {"identifier": "string",
"integration_id": "651586fca6078e98982dbd90",
"category": "string",
"class": "string",
"model": "string",
"locations": ["string"
],
"availability_zones": {"property1": ["string"
],
"property2": ["string"
]
}
},
"price": {"mills": 0,
"term": "once"
},
"compatible": true,
"low_resource": true,
"location_ids": ["string"
]
}
},
"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
}
}
}
}
}
}

Get Compatible Images

Returns a list of Images that are compatible with the specified Container. Used to quickly find Images that can be used for reimaging the Container.

Requires the containers-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId

required

string

The ID of the requested Container.

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 compatible Images.

default

General error response from the platform

get/v1/containers/{containerId}/compatible-images

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"name": "string",
"size": 0,
"about": {"description": "string"
},
"backend": {"provider": "string",
"size": 0,
"file_name": "string",
"file_id": "string"
},
"requires": {"nvidia_gpu": true
},
"build": {"args": {"property1": "string",
"property2": "string"
}
},
"builder": {"integration_id": "651586fca6078e98982dbd90"
},
"config": {"user": "string",
"ports": [{"host": 0,
"container": 0,
"type": "string"
}
],
"env": {"property1": "string",
"property2": "string"
},
"labels": {"property1": "string",
"property2": "string"
},
"command": ["string"
],
"entrypoint": ["string"
],
"volumes": [{"path": "string",
"mode": "ro"
}
],
"workdir": "string",
"signal_stop": "string"
},
"source": {"type": "direct",
"details": {"id": "string",
"origin": {"type": "docker-hub",
"details": {"existing": {"source_id": null
},
"target": "string",
"username": "string",
"token": "string"
}
}
},
"override": {"target": "string",
"targz_url": "string"
}
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"factory": {"node_id": "string",
"cached": "2021-01-30T08:30:00Z",
"acknowledged": "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"
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
]
}

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

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
}
}
]
}
}
}

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 Function Job

Used to perform different actions on a given Function Container.

Requires the containers-functions-trigger capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId

required

string

The ID of the requested container.

Request Body schema: application/json

Parameters for creating a new container function job.

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

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/containers/{containerId}/functions/tasks

Request samples

Payload

application/json

{"action": "trigger",
"contents": {"token": "string",
"runtime_variables": {"environment_variables": {"property1": "string",
"property2": "string"
}
}
}
}

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 Backup

Requires the containers-backups-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

containerId required	string The ID of the container.
backupId required	string The ID of the container backup.

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/containers/{containerId}/backups/{backupId}

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
}
}
]
}
}
}

➔ Next to Instances

Containers

List Containers

query Parameters

Filter Field

Create Container

Request Body schema: application/json

Get Container

path Parameters

query Parameters

Update Container

path Parameters

Request Body schema: application/json

Delete Container

path Parameters

Get Container Summary

path Parameters

Create Container Job

path Parameters

Request Body schema: application/json

List Container Servers

path Parameters

query Parameters

List Compatible Servers

path Parameters

query Parameters

Get Compatible Images

path Parameters

query Parameters

Create Instances

path Parameters

Request Body schema: application/json

Delete Container Instance

path Parameters

Expire SSH Credentials

path Parameters

Create Function Job

path Parameters

Request Body schema: application/json

Delete Container Backup

path Parameters