Endpoints related to managing containers, such as starting/stopping/reconfiguring and telemetry.
Requires the containers-view
capability.
Returns a list of Containers.
General error response from the platform
{- "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": "virtual-machine-v1",
- "id": "651586fca6078e98982dbd90"
}, - "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"
}
}, - "resources": {
- "cpu": {
- "shares": {
- "limit": 0,
- "reserve": 0
}, - "cpus": "string"
}, - "ram": {
- "limit": "1G",
- "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,
- "block_device": 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": "651586fca6078e98982dbd90",
- "instance_id": "651586fca6078e98982dbd90",
- "environment_id": "651586fca6078e98982dbd90",
- "virtual_machine": {
- "id": null
}
}, - "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": {
- "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"
}
}
}, - "visitors": {
- "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"
}
}
}, - "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": null,
- "ipv6": null,
- "type": null,
- "details": null,
- "bind_host": null
}
}, - "discovery": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "empty_set_delay": null,
- "hosts": { },
- "custom_resolvers": [ ]
}
}, - "vpn": {
- "enable": true,
- "container_id": "string",
- "auto_update": true,
- "config": {
- "allow_internet": null,
- "auth": { }
}
}, - "scheduler": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "public": null,
- "access_keys": [ ]
}
}
}, - "acl": {
- "roles": {
- "property1": {
- "view": null,
- "modify": null,
- "manage": null
}, - "property2": {
- "view": null,
- "modify": null,
- "manage": null
}
}
}, - "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": null,
- "cidr": null
}
}
}, - "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": null,
- "name": null,
- "state": null,
- "image": null,
- "environment": 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": null,
- "ipv6": null,
- "type": null,
- "details": null,
- "bind_host": null
}
}, - "discovery": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "empty_set_delay": null,
- "hosts": { },
- "custom_resolvers": [ ]
}
}, - "vpn": {
- "enable": true,
- "container_id": "string",
- "auto_update": true,
- "config": {
- "allow_internet": null,
- "auth": { }
}
}, - "scheduler": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "public": null,
- "access_keys": [ ]
}
}
}, - "acl": {
- "roles": {
- "property1": {
- "view": null,
- "modify": null,
- "manage": null
}, - "property2": {
- "view": null,
- "modify": null,
- "manage": null
}
}
}, - "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": null,
- "cidr": null
}
}
}, - "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": null,
- "name": null,
- "state": null,
- "image": null,
- "environment": null
}
]
}
}
}, - "api_keys": {
- "property1": {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "hub_id": "651586fca6078e98982dbd90",
- "secret": "string",
- "permissions": {
- "all_environments": true,
- "environments": [
- {
- "id": null,
- "manage": null
}
]
}, - "capabilities": {
- "all": true,
- "specific": [
- "string"
]
}, - "ips": [
- "string"
], - "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z"
}
}, - "property2": {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "hub_id": "651586fca6078e98982dbd90",
- "secret": "string",
- "permissions": {
- "all_environments": true,
- "environments": [
- {
- "id": null,
- "manage": null
}
]
}, - "capabilities": {
- "all": true,
- "specific": [
- "string"
]
}, - "ips": [
- "string"
], - "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z"
}
}
}
}, - "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": null
}, - "access": {
- "env_variable": null,
- "internal_api": null,
- "file": null
}, - "source": {
- "type": null,
- "details": null
}
}
], - "containers": {
- "property1": {
- "name": "string",
- "image": {
- "name": null,
- "origin": null,
- "build": null,
- "builder": null
}, - "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": null,
- "builder": null
}, - "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": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "empty_set_delay": null,
- "hosts": null,
- "custom_resolvers": null
}
}, - "loadbalancer": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "ipv4": null,
- "ipv6": null,
- "type": null,
- "details": null,
- "bind_host": null
}
}, - "scheduler": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "public": null,
- "access_keys": null
}
}, - "vpn": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "auth": null,
- "allow_internet": null
}
}
}, - "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": null
}, - "access": {
- "env_variable": null,
- "internal_api": null,
- "file": null
}, - "source": {
- "type": null,
- "details": null
}
}
], - "containers": {
- "property1": {
- "name": "string",
- "image": {
- "name": null,
- "origin": null,
- "build": null,
- "builder": null
}, - "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": null,
- "builder": null
}, - "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": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "empty_set_delay": null,
- "hosts": null,
- "custom_resolvers": null
}
}, - "loadbalancer": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "ipv4": null,
- "ipv6": null,
- "type": null,
- "details": null,
- "bind_host": null
}
}, - "scheduler": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "public": null,
- "access_keys": null
}
}, - "vpn": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "auth": null,
- "allow_internet": null
}
}
}, - "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": { }
}, - "custom_resolvers": [
- null
]
}
}, - "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": { }
}, - "custom_resolvers": [
- null
]
}
}, - "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"
]
}
}
}
Requires the containers-deploy
capability.
Parameters for creating a new Container.
Returns a Container.
General error response from the platform
{- "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"
}
}, - "resources": {
- "cpu": {
- "shares": {
- "limit": 0,
- "reserve": 0
}, - "cpus": "string"
}, - "ram": {
- "limit": "1G",
- "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,
- "block_device": 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
}
}
{- "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": "virtual-machine-v1",
- "id": "651586fca6078e98982dbd90"
}, - "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"
}
}, - "resources": {
- "cpu": {
- "shares": {
- "limit": 0,
- "reserve": 0
}, - "cpus": "string"
}, - "ram": {
- "limit": "1G",
- "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,
- "block_device": 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": "651586fca6078e98982dbd90",
- "instance_id": "651586fca6078e98982dbd90",
- "environment_id": "651586fca6078e98982dbd90",
- "virtual_machine": {
- "id": "651586fca6078e98982dbd90"
}
}, - "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"
}
}
}
]
}
}
}
Gets a Container.
Requires the containers-view
capability.
Returns a Container.
General error response from the platform
{- "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": "virtual-machine-v1",
- "id": "651586fca6078e98982dbd90"
}, - "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"
}
}, - "resources": {
- "cpu": {
- "shares": {
- "limit": 0,
- "reserve": 0
}, - "cpus": "string"
}, - "ram": {
- "limit": "1G",
- "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,
- "block_device": 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": "651586fca6078e98982dbd90",
- "instance_id": "651586fca6078e98982dbd90",
- "environment_id": "651586fca6078e98982dbd90",
- "virtual_machine": {
- "id": "651586fca6078e98982dbd90"
}
}, - "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": {
- "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"
}
}
}, - "visitors": {
- "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"
}
}
}, - "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": null,
- "ipv6": null,
- "type": null,
- "details": null,
- "bind_host": null
}
}, - "discovery": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "empty_set_delay": null,
- "hosts": { },
- "custom_resolvers": [ ]
}
}, - "vpn": {
- "enable": true,
- "container_id": "string",
- "auto_update": true,
- "config": {
- "allow_internet": null,
- "auth": { }
}
}, - "scheduler": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "public": null,
- "access_keys": [ ]
}
}
}, - "acl": {
- "roles": {
- "property1": {
- "view": null,
- "modify": null,
- "manage": null
}, - "property2": {
- "view": null,
- "modify": null,
- "manage": null
}
}
}, - "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": null,
- "cidr": null
}
}
}, - "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": null,
- "name": null,
- "state": null,
- "image": null,
- "environment": 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": null,
- "ipv6": null,
- "type": null,
- "details": null,
- "bind_host": null
}
}, - "discovery": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "empty_set_delay": null,
- "hosts": { },
- "custom_resolvers": [ ]
}
}, - "vpn": {
- "enable": true,
- "container_id": "string",
- "auto_update": true,
- "config": {
- "allow_internet": null,
- "auth": { }
}
}, - "scheduler": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "public": null,
- "access_keys": [ ]
}
}
}, - "acl": {
- "roles": {
- "property1": {
- "view": null,
- "modify": null,
- "manage": null
}, - "property2": {
- "view": null,
- "modify": null,
- "manage": null
}
}
}, - "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": null,
- "cidr": null
}
}
}, - "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": null,
- "name": null,
- "state": null,
- "image": null,
- "environment": null
}
]
}
}
}, - "api_keys": {
- "property1": {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "hub_id": "651586fca6078e98982dbd90",
- "secret": "string",
- "permissions": {
- "all_environments": true,
- "environments": [
- {
- "id": null,
- "manage": null
}
]
}, - "capabilities": {
- "all": true,
- "specific": [
- "string"
]
}, - "ips": [
- "string"
], - "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z"
}
}, - "property2": {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "hub_id": "651586fca6078e98982dbd90",
- "secret": "string",
- "permissions": {
- "all_environments": true,
- "environments": [
- {
- "id": null,
- "manage": null
}
]
}, - "capabilities": {
- "all": true,
- "specific": [
- "string"
]
}, - "ips": [
- "string"
], - "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z"
}
}
}
}, - "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": null
}, - "access": {
- "env_variable": null,
- "internal_api": null,
- "file": null
}, - "source": {
- "type": null,
- "details": null
}
}
], - "containers": {
- "property1": {
- "name": "string",
- "image": {
- "name": null,
- "origin": null,
- "build": null,
- "builder": null
}, - "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": null,
- "builder": null
}, - "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": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "empty_set_delay": null,
- "hosts": null,
- "custom_resolvers": null
}
}, - "loadbalancer": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "ipv4": null,
- "ipv6": null,
- "type": null,
- "details": null,
- "bind_host": null
}
}, - "scheduler": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "public": null,
- "access_keys": null
}
}, - "vpn": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "auth": null,
- "allow_internet": null
}
}
}, - "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": null
}, - "access": {
- "env_variable": null,
- "internal_api": null,
- "file": null
}, - "source": {
- "type": null,
- "details": null
}
}
], - "containers": {
- "property1": {
- "name": "string",
- "image": {
- "name": null,
- "origin": null,
- "build": null,
- "builder": null
}, - "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": null,
- "builder": null
}, - "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": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "empty_set_delay": null,
- "hosts": null,
- "custom_resolvers": null
}
}, - "loadbalancer": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "ipv4": null,
- "ipv6": null,
- "type": null,
- "details": null,
- "bind_host": null
}
}, - "scheduler": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "public": null,
- "access_keys": null
}
}, - "vpn": {
- "service": {
- "enable": null,
- "high_availability": null,
- "auto_update": null
}, - "config": {
- "auth": null,
- "allow_internet": null
}
}
}, - "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": { }
}, - "custom_resolvers": [
- null
]
}
}, - "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": { }
}, - "custom_resolvers": [
- null
]
}
}, - "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"
]
}
}
}
Updates the specified Container.
Requires the containers-manage
capability.
Parameters for updating a Container.
Returns the updated Container.
General error response from the platform
{- "name": "string",
- "identifier": "string",
- "deprecate": true,
- "lock": true,
- "annotation": {
- "property1": "string",
- "property2": "string"
}
}
{- "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": "virtual-machine-v1",
- "id": "651586fca6078e98982dbd90"
}, - "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"
}
}, - "resources": {
- "cpu": {
- "shares": {
- "limit": 0,
- "reserve": 0
}, - "cpus": "string"
}, - "ram": {
- "limit": "1G",
- "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,
- "block_device": 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": "651586fca6078e98982dbd90",
- "instance_id": "651586fca6078e98982dbd90",
- "environment_id": "651586fca6078e98982dbd90",
- "virtual_machine": {
- "id": "651586fca6078e98982dbd90"
}
}, - "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"
}
}
}
]
}
}
}
Requires the containers-manage
capability.
Returns a Job Descriptor.
General error response from the platform
{- "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
}
}
]
}
}
}
Requires the containers-view
capability.
Returns an Container summary resource.
General error response from the platform
{- "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
}
}
}
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
Returns a Job Descriptor.
General error response from the platform
{- "action": "start"
}
{- "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
}
}
]
}
}
}
Lists all Servers that currently have an Instance of this Container deployed to them.
Requires the containers-view
capability.
Returns an array of Server IDs / number of Instances of this Container deployed to them.
General error response from the platform
{- "data": {
- "server_id": "651586fca6078e98982dbd90",
- "instances": 0
}
}
Gets a list of servers that are compatible with the specified Container and its restrictions (tags, etc).
Requires the containers-view
capability.
Returns a list of Servers.
General error response from the platform
{- "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
}, - "allocations": {
- "cpu_shares": {
- "total": 0,
- "allocatable": 0,
- "allocated": 0
}, - "ram": {
- "total_mb": 0,
- "allocatable_mb": 0,
- "allocated_mb": 0
}
}
}
}
], - "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",
- "hypervisor": true,
- "extra": { }
}
}, - "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",
- "hypervisor": true,
- "extra": { }
}
}, - "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": { }
}
}, - "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": { }
}
}, - "public": true,
- "usable": true,
- "editable": true
}
}
}
}
}
}
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.
Returns a list of compatible Images.
General error response from the platform
{- "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
}
}
}
]
}
Manually create Instances of a Container.
Requires the containers-update
capability.
Returns a Job Descriptor.
General error response from the platform
[- {
- "server_id": "string",
- "new_instances": 0
}
]
{- "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
}
}
]
}
}
}
Requires the containers-update
capability.
Returns a Job Descriptor.
General error response from the platform
{- "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
}
}
]
}
}
}
Instantly expires any SSH credentials generated for this Instance.
Requires the containers-ssh
capability.
Returns the number of tokens removed.
General error response from the platform
{- "data": {
- "tokens": 0
}
}
Used to perform different actions on a given Function Container.
Requires the containers-functions-trigger
capability.
Returns a Job Descriptor.
General error response from the platform
{- "action": "trigger",
- "contents": {
- "token": "string",
- "runtime_variables": {
- "environment_variables": {
- "property1": "string",
- "property2": "string"
}
}
}
}
{- "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
}
}
]
}
}
}
Requires the containers-backups-manage
capability.
Returns a Job Descriptor.
General error response from the platform
{- "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
}
}
]
}
}
}