Requires the virtual-machines-view
capability.
Returns a list of virtual machines.
General error response from the platform
{- "data": [
- {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "identifier": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "environment": {
- "id": "651586fca6078e98982dbd90",
- "cluster": "string"
}, - "hub_id": "651586fca6078e98982dbd90",
- "config": {
- "network": {
- "public": "enable",
- "hostname": "string",
- "ports": [
- "string"
]
}, - "deploy": {
- "constraints": {
- "node": {
- "tags": {
- "any": null,
- "all": null
}
}, - "secrets": [
- "string"
], - "containers": [
- "string"
]
}, - "shutdown": {
- "graceful_timeout": "72h45m2s",
- "signals": [
- "string"
]
}, - "startup": {
- "delay": "72h45m2s"
}, - "telemetry": {
- "retention": "72h45m2s",
- "interval": "72h45m2s",
- "disable": true
}
}, - "resources": {
- "ram": {
- "limit": "1G",
- "allocate": true
}, - "cpu": {
- "cores": {
- "number": 1,
- "allocate": true
}, - "cpus": "1"
}
}
}, - "image": {
- "type": "url",
- "details": {
- "url": "string"
}
}, - "container_id": "651586fca6078e98982dbd90",
- "volumes": [
- {
- "id": "651586fca6078e98982dbd90",
- "hash": "string",
- "config": {
- "local": {
- "max_size": "100G",
- "storage_pool": true
}, - "identifier": "string",
- "read_only": true
}
}
], - "annotations": {
- "property1": null,
- "property2": null
}, - "base_disk_size": "10G",
- "root_password": {
- "changed": "2021-01-30T08:30:00Z",
- "current": "string"
}, - "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"
}, - "deprecate": true,
- "lock": true,
- "meta": {
- "domains": [
- {
- "fqdn": "string",
- "record": {
- "id": "651586fca6078e98982dbd90",
- "hub_id": "651586fca6078e98982dbd90",
- "creator": {
- "id": null,
- "type": null
}, - "zone_id": "string",
- "name": "string",
- "resolved_domain": "string",
- "type": {
- "a": { },
- "aaaa": { },
- "cname": { },
- "ns": { },
- "mx": { },
- "txt": { },
- "alias": { },
- "srv": { },
- "caa": { },
- "linked": { }
}, - "features": {
- "certificate": null
}, - "state": {
- "changed": null,
- "error": { }
}, - "events": {
- "property1": null,
- "property2": null
}
}
}
], - "ips": [
- {
- "id": "651586fca6078e98982dbd90",
- "hub_id": "651586fca6078e98982dbd90",
- "kind": "ipv4",
- "assignment": {
- "container_id": "string",
- "instance_id": "string",
- "environment_id": "string"
}, - "pool_id": "string",
- "address": "string",
- "gateway": "string",
- "cidr": "string",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": null,
- "time": null
}
}
}
]
}
}
], - "includes": {
- "creators": {
- "accounts": {
- "property1": {
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string"
}, - "id": "string",
- "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}, - "property2": {
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string"
}, - "id": "string",
- "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}
}, - "employees": {
- "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"
}
}
}
}, - "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"
}, - "clusters": {
- "property1": {
- "id": "string",
- "identifier": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": 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"
}
}, - "property2": {
- "id": "string",
- "identifier": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": 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"
}
}
}, - "containers": {
- "property1": {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "name": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "environment": {
- "id": "651586fca6078e98982dbd90",
- "cluster": "string",
- "container_subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}
}
}, - "hub_id": "651586fca6078e98982dbd90",
- "image": {
- "id": "651586fca6078e98982dbd90",
- "extension": {
- "identifier": "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": null
}
}, - "constraints": {
- "node": {
- "tags": { }
}, - "secrets": [
- null
]
}, - "shutdown": {
- "graceful_timeout": "72h45m2s",
- "signals": [
- null
]
}, - "startup": {
- "delay": "72h45m2s"
}, - "update": {
- "stagger": "72h45m2s"
}, - "restart": {
- "condition": "always",
- "delay": "72h45m2s",
- "max_attempts": 0
}, - "health_check": {
- "command": "string",
- "retries": 0,
- "delay": "72h45m2s",
- "interval": "72h45m2s",
- "timeout": "72h45m2s",
- "restart": true
}, - "telemetry": {
- "retention": "72h45m2s",
- "interval": "72h45m2s",
- "disable": true
}
}, - "scale": {
- "autoscale_group": "string",
- "instances": {
- "max": 0,
- "max_server": 0,
- "min_ttl": "72h45m2s"
}, - "window": "72h45m2s",
- "thresholds": [
- {
- "type": null,
- "details": { }
}
]
}, - "runtime": {
- "command": {
- "path": "string",
- "args": "string"
}, - "namespaces": [
- "ipc"
], - "environment_vars": {
- "property1": "string",
- "property2": "string"
}, - "privileged": true,
- "capabilities": [
- "CAP_CHOWN"
], - "workdir": "string",
- "sysctl": {
- "property1": "string",
- "property2": "string"
}, - "rlimits": {
- "property1": {
- "hard": null,
- "soft": null
}, - "property2": {
- "hard": null,
- "soft": null
}
}, - "seccomp": {
- "disable": true,
- "rules": [
- null
]
}, - "host": {
- "expose_proc": true
}, - "rootfs": {
- "readonly": true
}, - "devices": {
- "shm_size": "64M"
}
}, - "resources": {
- "cpu": {
- "shares": {
- "limit": null,
- "reserve": null
}, - "cpus": "string"
}, - "ram": {
- "limit": "1G",
- "reserve": "string"
}
}, - "integrations": {
- "webhooks": {
- "events": {
- "deploy": null,
- "start": null,
- "stop": null
}, - "config": "string"
}, - "files": [
- {
- "source": null,
- "destination": null
}
], - "lets_encrypt": {
- "enable": true,
- "certificate_path": "string",
- "chain_path": "string",
- "key_path": "string",
- "bundle_path": "string",
- "additional_certs_path": "string"
}, - "backups": {
- "integration_id": "my-image-source",
- "backup": {
- "command": null,
- "timeout": null,
- "cron_string": null
}, - "restore": {
- "command": null,
- "timeout": null
}, - "retention": "365d"
}, - "shared_file_systems": {
- "property1": {
- "writable": null,
- "mount_point": null
}, - "property2": {
- "writable": null,
- "mount_point": null
}
}, - "logs": {
- "groups": [
- null
]
}
}
}, - "deployment": {
- "version": "v1.2.3-dev"
}, - "instances": 0,
- "volumes": [
- {
- "id": "651586fca6078e98982dbd90",
- "hash": "string",
- "config": {
- "read_only": true,
- "block_device": true,
- "local": {
- "max_size": null,
- "storage_pool": null
}, - "destination": "string",
- "remote_access": {
- "enable": null,
- "ips": [ ],
- "webhook": null,
- "password": { }
}
}
}
], - "annotations": {
- "property1": null,
- "property2": null
}, - "role": "orchestrator",
- "stateful": true,
- "deprecate": true,
- "lock": true,
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z",
- "started": "2021-01-30T08:30:00Z"
}, - "meta": {
- "instances_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "domains": [
- {
- "fqdn": "string",
- "record": {
- "id": null,
- "hub_id": null,
- "creator": null,
- "zone_id": null,
- "name": null,
- "resolved_domain": null,
- "type": null,
- "features": { },
- "state": null,
- "events": null
}
}
], - "ips": [
- {
- "id": "651586fca6078e98982dbd90",
- "hub_id": "651586fca6078e98982dbd90",
- "kind": "ipv4",
- "assignment": {
- "container_id": null,
- "instance_id": null,
- "environment_id": null
}, - "pool_id": "string",
- "address": "string",
- "gateway": "string",
- "cidr": "string",
- "state": {
- "changed": null,
- "error": { }
}
}
]
}
}, - "property2": {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "name": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "environment": {
- "id": "651586fca6078e98982dbd90",
- "cluster": "string",
- "container_subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}
}
}, - "hub_id": "651586fca6078e98982dbd90",
- "image": {
- "id": "651586fca6078e98982dbd90",
- "extension": {
- "identifier": "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": null
}
}, - "constraints": {
- "node": {
- "tags": { }
}, - "secrets": [
- null
]
}, - "shutdown": {
- "graceful_timeout": "72h45m2s",
- "signals": [
- null
]
}, - "startup": {
- "delay": "72h45m2s"
}, - "update": {
- "stagger": "72h45m2s"
}, - "restart": {
- "condition": "always",
- "delay": "72h45m2s",
- "max_attempts": 0
}, - "health_check": {
- "command": "string",
- "retries": 0,
- "delay": "72h45m2s",
- "interval": "72h45m2s",
- "timeout": "72h45m2s",
- "restart": true
}, - "telemetry": {
- "retention": "72h45m2s",
- "interval": "72h45m2s",
- "disable": true
}
}, - "scale": {
- "autoscale_group": "string",
- "instances": {
- "max": 0,
- "max_server": 0,
- "min_ttl": "72h45m2s"
}, - "window": "72h45m2s",
- "thresholds": [
- {
- "type": null,
- "details": { }
}
]
}, - "runtime": {
- "command": {
- "path": "string",
- "args": "string"
}, - "namespaces": [
- "ipc"
], - "environment_vars": {
- "property1": "string",
- "property2": "string"
}, - "privileged": true,
- "capabilities": [
- "CAP_CHOWN"
], - "workdir": "string",
- "sysctl": {
- "property1": "string",
- "property2": "string"
}, - "rlimits": {
- "property1": {
- "hard": null,
- "soft": null
}, - "property2": {
- "hard": null,
- "soft": null
}
}, - "seccomp": {
- "disable": true,
- "rules": [
- null
]
}, - "host": {
- "expose_proc": true
}, - "rootfs": {
- "readonly": true
}, - "devices": {
- "shm_size": "64M"
}
}, - "resources": {
- "cpu": {
- "shares": {
- "limit": null,
- "reserve": null
}, - "cpus": "string"
}, - "ram": {
- "limit": "1G",
- "reserve": "string"
}
}, - "integrations": {
- "webhooks": {
- "events": {
- "deploy": null,
- "start": null,
- "stop": null
}, - "config": "string"
}, - "files": [
- {
- "source": null,
- "destination": null
}
], - "lets_encrypt": {
- "enable": true,
- "certificate_path": "string",
- "chain_path": "string",
- "key_path": "string",
- "bundle_path": "string",
- "additional_certs_path": "string"
}, - "backups": {
- "integration_id": "my-image-source",
- "backup": {
- "command": null,
- "timeout": null,
- "cron_string": null
}, - "restore": {
- "command": null,
- "timeout": null
}, - "retention": "365d"
}, - "shared_file_systems": {
- "property1": {
- "writable": null,
- "mount_point": null
}, - "property2": {
- "writable": null,
- "mount_point": null
}
}, - "logs": {
- "groups": [
- null
]
}
}
}, - "deployment": {
- "version": "v1.2.3-dev"
}, - "instances": 0,
- "volumes": [
- {
- "id": "651586fca6078e98982dbd90",
- "hash": "string",
- "config": {
- "read_only": true,
- "block_device": true,
- "local": {
- "max_size": null,
- "storage_pool": null
}, - "destination": "string",
- "remote_access": {
- "enable": null,
- "ips": [ ],
- "webhook": null,
- "password": { }
}
}
}
], - "annotations": {
- "property1": null,
- "property2": null
}, - "role": "orchestrator",
- "stateful": true,
- "deprecate": true,
- "lock": true,
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z",
- "started": "2021-01-30T08:30:00Z"
}, - "meta": {
- "instances_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "domains": [
- {
- "fqdn": "string",
- "record": {
- "id": null,
- "hub_id": null,
- "creator": null,
- "zone_id": null,
- "name": null,
- "resolved_domain": null,
- "type": null,
- "features": { },
- "state": null,
- "events": null
}
}
], - "ips": [
- {
- "id": "651586fca6078e98982dbd90",
- "hub_id": "651586fca6078e98982dbd90",
- "kind": "ipv4",
- "assignment": {
- "container_id": null,
- "instance_id": null,
- "environment_id": null
}, - "pool_id": "string",
- "address": "string",
- "gateway": "string",
- "cidr": "string",
- "state": {
- "changed": null,
- "error": { }
}
}
]
}
}
}
}
}
Requires the virtual-machines-deploy
capability.
Parameters for creating a new virtual machine.
Returns the newly created virtual machine.
General error response from the platform
{- "identifier": "string",
- "name": "string",
- "environment_id": "string",
- "image": {
- "type": "url",
- "details": {
- "url": "string"
}
}, - "config": {
- "network": {
- "public": "enable",
- "hostname": "string",
- "ports": [
- "string"
]
}, - "deploy": {
- "constraints": {
- "node": {
- "tags": {
- "any": [
- "string"
], - "all": [
- "string"
]
}
}, - "secrets": [
- "string"
], - "containers": [
- "string"
]
}, - "shutdown": {
- "graceful_timeout": "72h45m2s",
- "signals": [
- "string"
]
}, - "startup": {
- "delay": "72h45m2s"
}, - "telemetry": {
- "retention": "72h45m2s",
- "interval": "72h45m2s",
- "disable": true
}
}, - "resources": {
- "ram": {
- "limit": "1G",
- "allocate": true
}, - "cpu": {
- "cores": {
- "number": 1,
- "allocate": true
}, - "cpus": "1"
}
}
}, - "lock": true,
- "volumes": [
- {
- "local": {
- "max_size": "100G",
- "storage_pool": true
}, - "identifier": "string",
- "read_only": true
}
], - "base_disk_size": "10G",
- "annotations": {
- "property1": null,
- "property2": null
}
}
{- "data": {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "identifier": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "environment": {
- "id": "651586fca6078e98982dbd90",
- "cluster": "string"
}, - "hub_id": "651586fca6078e98982dbd90",
- "config": {
- "network": {
- "public": "enable",
- "hostname": "string",
- "ports": [
- "string"
]
}, - "deploy": {
- "constraints": {
- "node": {
- "tags": {
- "any": [
- null
], - "all": [
- null
]
}
}, - "secrets": [
- "string"
], - "containers": [
- "string"
]
}, - "shutdown": {
- "graceful_timeout": "72h45m2s",
- "signals": [
- "string"
]
}, - "startup": {
- "delay": "72h45m2s"
}, - "telemetry": {
- "retention": "72h45m2s",
- "interval": "72h45m2s",
- "disable": true
}
}, - "resources": {
- "ram": {
- "limit": "1G",
- "allocate": true
}, - "cpu": {
- "cores": {
- "number": 1,
- "allocate": true
}, - "cpus": "1"
}
}
}, - "image": {
- "type": "url",
- "details": {
- "url": "string"
}
}, - "container_id": "651586fca6078e98982dbd90",
- "volumes": [
- {
- "id": "651586fca6078e98982dbd90",
- "hash": "string",
- "config": {
- "local": {
- "max_size": "100G",
- "storage_pool": true
}, - "identifier": "string",
- "read_only": true
}
}
], - "annotations": {
- "property1": null,
- "property2": null
}, - "base_disk_size": "10G",
- "root_password": {
- "changed": "2021-01-30T08:30:00Z",
- "current": "string"
}, - "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"
}, - "deprecate": true,
- "lock": true,
- "meta": {
- "domains": [
- {
- "fqdn": "string",
- "record": {
- "id": "651586fca6078e98982dbd90",
- "hub_id": "651586fca6078e98982dbd90",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "zone_id": "string",
- "name": "string",
- "resolved_domain": "string",
- "type": {
- "a": {
- "ip": null
}, - "aaaa": {
- "ip": null
}, - "cname": {
- "domain": null
}, - "ns": {
- "domain": null
}, - "mx": {
- "priority": null,
- "domain": null
}, - "txt": {
- "value": null
}, - "alias": {
- "domain": null
}, - "srv": {
- "weight": null,
- "priority": null,
- "port": null,
- "domain": null
}, - "caa": {
- "tag": null,
- "value": null
}, - "linked": {
- "features": { },
- "container_id": null
}
}, - "features": {
- "certificate": {
- "id": null,
- "generated": null,
- "wildcard_child": null
}
}, - "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": null,
- "time": null
}
}, - "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z"
}
}
}
], - "ips": [
- {
- "id": "651586fca6078e98982dbd90",
- "hub_id": "651586fca6078e98982dbd90",
- "kind": "ipv4",
- "assignment": {
- "container_id": "string",
- "instance_id": "string",
- "environment_id": "string"
}, - "pool_id": "string",
- "address": "string",
- "gateway": "string",
- "cidr": "string",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}
}
]
}
}, - "includes": {
- "creators": {
- "accounts": {
- "property1": {
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string"
}, - "id": "string",
- "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}, - "property2": {
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string"
}, - "id": "string",
- "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}
}, - "employees": {
- "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"
}
}
}
}, - "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"
}, - "clusters": {
- "property1": {
- "id": "string",
- "identifier": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": 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"
}
}, - "property2": {
- "id": "string",
- "identifier": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": 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"
}
}
}, - "containers": {
- "property1": {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "name": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "environment": {
- "id": "651586fca6078e98982dbd90",
- "cluster": "string",
- "container_subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}
}
}, - "hub_id": "651586fca6078e98982dbd90",
- "image": {
- "id": "651586fca6078e98982dbd90",
- "extension": {
- "identifier": "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": null
}
}, - "constraints": {
- "node": {
- "tags": { }
}, - "secrets": [
- null
]
}, - "shutdown": {
- "graceful_timeout": "72h45m2s",
- "signals": [
- null
]
}, - "startup": {
- "delay": "72h45m2s"
}, - "update": {
- "stagger": "72h45m2s"
}, - "restart": {
- "condition": "always",
- "delay": "72h45m2s",
- "max_attempts": 0
}, - "health_check": {
- "command": "string",
- "retries": 0,
- "delay": "72h45m2s",
- "interval": "72h45m2s",
- "timeout": "72h45m2s",
- "restart": true
}, - "telemetry": {
- "retention": "72h45m2s",
- "interval": "72h45m2s",
- "disable": true
}
}, - "scale": {
- "autoscale_group": "string",
- "instances": {
- "max": 0,
- "max_server": 0,
- "min_ttl": "72h45m2s"
}, - "window": "72h45m2s",
- "thresholds": [
- {
- "type": null,
- "details": { }
}
]
}, - "runtime": {
- "command": {
- "path": "string",
- "args": "string"
}, - "namespaces": [
- "ipc"
], - "environment_vars": {
- "property1": "string",
- "property2": "string"
}, - "privileged": true,
- "capabilities": [
- "CAP_CHOWN"
], - "workdir": "string",
- "sysctl": {
- "property1": "string",
- "property2": "string"
}, - "rlimits": {
- "property1": {
- "hard": null,
- "soft": null
}, - "property2": {
- "hard": null,
- "soft": null
}
}, - "seccomp": {
- "disable": true,
- "rules": [
- null
]
}, - "host": {
- "expose_proc": true
}, - "rootfs": {
- "readonly": true
}, - "devices": {
- "shm_size": "64M"
}
}, - "resources": {
- "cpu": {
- "shares": {
- "limit": null,
- "reserve": null
}, - "cpus": "string"
}, - "ram": {
- "limit": "1G",
- "reserve": "string"
}
}, - "integrations": {
- "webhooks": {
- "events": {
- "deploy": null,
- "start": null,
- "stop": null
}, - "config": "string"
}, - "files": [
- {
- "source": null,
- "destination": null
}
], - "lets_encrypt": {
- "enable": true,
- "certificate_path": "string",
- "chain_path": "string",
- "key_path": "string",
- "bundle_path": "string",
- "additional_certs_path": "string"
}, - "backups": {
- "integration_id": "my-image-source",
- "backup": {
- "command": null,
- "timeout": null,
- "cron_string": null
}, - "restore": {
- "command": null,
- "timeout": null
}, - "retention": "365d"
}, - "shared_file_systems": {
- "property1": {
- "writable": null,
- "mount_point": null
}, - "property2": {
- "writable": null,
- "mount_point": null
}
}, - "logs": {
- "groups": [
- null
]
}
}
}, - "deployment": {
- "version": "v1.2.3-dev"
}, - "instances": 0,
- "volumes": [
- {
- "id": "651586fca6078e98982dbd90",
- "hash": "string",
- "config": {
- "read_only": true,
- "block_device": true,
- "local": {
- "max_size": null,
- "storage_pool": null
}, - "destination": "string",
- "remote_access": {
- "enable": null,
- "ips": [ ],
- "webhook": null,
- "password": { }
}
}
}
], - "annotations": {
- "property1": null,
- "property2": null
}, - "role": "orchestrator",
- "stateful": true,
- "deprecate": true,
- "lock": true,
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z",
- "started": "2021-01-30T08:30:00Z"
}, - "meta": {
- "instances_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "domains": [
- {
- "fqdn": "string",
- "record": {
- "id": null,
- "hub_id": null,
- "creator": null,
- "zone_id": null,
- "name": null,
- "resolved_domain": null,
- "type": null,
- "features": { },
- "state": null,
- "events": null
}
}
], - "ips": [
- {
- "id": "651586fca6078e98982dbd90",
- "hub_id": "651586fca6078e98982dbd90",
- "kind": "ipv4",
- "assignment": {
- "container_id": null,
- "instance_id": null,
- "environment_id": null
}, - "pool_id": "string",
- "address": "string",
- "gateway": "string",
- "cidr": "string",
- "state": {
- "changed": null,
- "error": { }
}
}
]
}
}, - "property2": {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "name": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "environment": {
- "id": "651586fca6078e98982dbd90",
- "cluster": "string",
- "container_subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}
}
}, - "hub_id": "651586fca6078e98982dbd90",
- "image": {
- "id": "651586fca6078e98982dbd90",
- "extension": {
- "identifier": "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": null
}
}, - "constraints": {
- "node": {
- "tags": { }
}, - "secrets": [
- null
]
}, - "shutdown": {
- "graceful_timeout": "72h45m2s",
- "signals": [
- null
]
}, - "startup": {
- "delay": "72h45m2s"
}, - "update": {
- "stagger": "72h45m2s"
}, - "restart": {
- "condition": "always",
- "delay": "72h45m2s",
- "max_attempts": 0
}, - "health_check": {
- "command": "string",
- "retries": 0,
- "delay": "72h45m2s",
- "interval": "72h45m2s",
- "timeout": "72h45m2s",
- "restart": true
}, - "telemetry": {
- "retention": "72h45m2s",
- "interval": "72h45m2s",
- "disable": true
}
}, - "scale": {
- "autoscale_group": "string",
- "instances": {
- "max": 0,
- "max_server": 0,
- "min_ttl": "72h45m2s"
}, - "window": "72h45m2s",
- "thresholds": [
- {
- "type": null,
- "details": { }
}
]
}, - "runtime": {
- "command": {
- "path": "string",
- "args": "string"
}, - "namespaces": [
- "ipc"
], - "environment_vars": {
- "property1": "string",
- "property2": "string"
}, - "privileged": true,
- "capabilities": [
- "CAP_CHOWN"
], - "workdir": "string",
- "sysctl": {
- "property1": "string",
- "property2": "string"
}, - "rlimits": {
- "property1": {
- "hard": null,
- "soft": null
}, - "property2": {
- "hard": null,
- "soft": null
}
}, - "seccomp": {
- "disable": true,
- "rules": [
- null
]
}, - "host": {
- "expose_proc": true
}, - "rootfs": {
- "readonly": true
}, - "devices": {
- "shm_size": "64M"
}
}, - "resources": {
- "cpu": {
- "shares": {
- "limit": null,
- "reserve": null
}, - "cpus": "string"
}, - "ram": {
- "limit": "1G",
- "reserve": "string"
}
}, - "integrations": {
- "webhooks": {
- "events": {
- "deploy": null,
- "start": null,
- "stop": null
}, - "config": "string"
}, - "files": [
- {
- "source": null,
- "destination": null
}
], - "lets_encrypt": {
- "enable": true,
- "certificate_path": "string",
- "chain_path": "string",
- "key_path": "string",
- "bundle_path": "string",
- "additional_certs_path": "string"
}, - "backups": {
- "integration_id": "my-image-source",
- "backup": {
- "command": null,
- "timeout": null,
- "cron_string": null
}, - "restore": {
- "command": null,
- "timeout": null
}, - "retention": "365d"
}, - "shared_file_systems": {
- "property1": {
- "writable": null,
- "mount_point": null
}, - "property2": {
- "writable": null,
- "mount_point": null
}
}, - "logs": {
- "groups": [
- null
]
}
}
}, - "deployment": {
- "version": "v1.2.3-dev"
}, - "instances": 0,
- "volumes": [
- {
- "id": "651586fca6078e98982dbd90",
- "hash": "string",
- "config": {
- "read_only": true,
- "block_device": true,
- "local": {
- "max_size": null,
- "storage_pool": null
}, - "destination": "string",
- "remote_access": {
- "enable": null,
- "ips": [ ],
- "webhook": null,
- "password": { }
}
}
}
], - "annotations": {
- "property1": null,
- "property2": null
}, - "role": "orchestrator",
- "stateful": true,
- "deprecate": true,
- "lock": true,
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z",
- "started": "2021-01-30T08:30:00Z"
}, - "meta": {
- "instances_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "domains": [
- {
- "fqdn": "string",
- "record": {
- "id": null,
- "hub_id": null,
- "creator": null,
- "zone_id": null,
- "name": null,
- "resolved_domain": null,
- "type": null,
- "features": { },
- "state": null,
- "events": null
}
}
], - "ips": [
- {
- "id": "651586fca6078e98982dbd90",
- "hub_id": "651586fca6078e98982dbd90",
- "kind": "ipv4",
- "assignment": {
- "container_id": null,
- "instance_id": null,
- "environment_id": null
}, - "pool_id": "string",
- "address": "string",
- "gateway": "string",
- "cidr": "string",
- "state": {
- "changed": null,
- "error": { }
}
}
]
}
}
}
}
}
Retrieves a single virtual machine by ID.
Requires the virtual-machines-view
capability.
Returns the requested virtual machine.
General error response from the platform
{- "data": {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "identifier": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "environment": {
- "id": "651586fca6078e98982dbd90",
- "cluster": "string"
}, - "hub_id": "651586fca6078e98982dbd90",
- "config": {
- "network": {
- "public": "enable",
- "hostname": "string",
- "ports": [
- "string"
]
}, - "deploy": {
- "constraints": {
- "node": {
- "tags": {
- "any": [
- null
], - "all": [
- null
]
}
}, - "secrets": [
- "string"
], - "containers": [
- "string"
]
}, - "shutdown": {
- "graceful_timeout": "72h45m2s",
- "signals": [
- "string"
]
}, - "startup": {
- "delay": "72h45m2s"
}, - "telemetry": {
- "retention": "72h45m2s",
- "interval": "72h45m2s",
- "disable": true
}
}, - "resources": {
- "ram": {
- "limit": "1G",
- "allocate": true
}, - "cpu": {
- "cores": {
- "number": 1,
- "allocate": true
}, - "cpus": "1"
}
}
}, - "image": {
- "type": "url",
- "details": {
- "url": "string"
}
}, - "container_id": "651586fca6078e98982dbd90",
- "volumes": [
- {
- "id": "651586fca6078e98982dbd90",
- "hash": "string",
- "config": {
- "local": {
- "max_size": "100G",
- "storage_pool": true
}, - "identifier": "string",
- "read_only": true
}
}
], - "annotations": {
- "property1": null,
- "property2": null
}, - "base_disk_size": "10G",
- "root_password": {
- "changed": "2021-01-30T08:30:00Z",
- "current": "string"
}, - "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"
}, - "deprecate": true,
- "lock": true,
- "meta": {
- "domains": [
- {
- "fqdn": "string",
- "record": {
- "id": "651586fca6078e98982dbd90",
- "hub_id": "651586fca6078e98982dbd90",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "zone_id": "string",
- "name": "string",
- "resolved_domain": "string",
- "type": {
- "a": {
- "ip": null
}, - "aaaa": {
- "ip": null
}, - "cname": {
- "domain": null
}, - "ns": {
- "domain": null
}, - "mx": {
- "priority": null,
- "domain": null
}, - "txt": {
- "value": null
}, - "alias": {
- "domain": null
}, - "srv": {
- "weight": null,
- "priority": null,
- "port": null,
- "domain": null
}, - "caa": {
- "tag": null,
- "value": null
}, - "linked": {
- "features": { },
- "container_id": null
}
}, - "features": {
- "certificate": {
- "id": null,
- "generated": null,
- "wildcard_child": null
}
}, - "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": null,
- "time": null
}
}, - "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z"
}
}
}
], - "ips": [
- {
- "id": "651586fca6078e98982dbd90",
- "hub_id": "651586fca6078e98982dbd90",
- "kind": "ipv4",
- "assignment": {
- "container_id": "string",
- "instance_id": "string",
- "environment_id": "string"
}, - "pool_id": "string",
- "address": "string",
- "gateway": "string",
- "cidr": "string",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}
}
]
}
}, - "includes": {
- "creators": {
- "accounts": {
- "property1": {
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string"
}, - "id": "string",
- "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}, - "property2": {
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string"
}, - "id": "string",
- "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}
}, - "employees": {
- "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"
}
}
}
}, - "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"
}, - "clusters": {
- "property1": {
- "id": "string",
- "identifier": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": 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"
}
}, - "property2": {
- "id": "string",
- "identifier": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": 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"
}
}
}, - "containers": {
- "property1": {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "name": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "environment": {
- "id": "651586fca6078e98982dbd90",
- "cluster": "string",
- "container_subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}
}
}, - "hub_id": "651586fca6078e98982dbd90",
- "image": {
- "id": "651586fca6078e98982dbd90",
- "extension": {
- "identifier": "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": null
}
}, - "constraints": {
- "node": {
- "tags": { }
}, - "secrets": [
- null
]
}, - "shutdown": {
- "graceful_timeout": "72h45m2s",
- "signals": [
- null
]
}, - "startup": {
- "delay": "72h45m2s"
}, - "update": {
- "stagger": "72h45m2s"
}, - "restart": {
- "condition": "always",
- "delay": "72h45m2s",
- "max_attempts": 0
}, - "health_check": {
- "command": "string",
- "retries": 0,
- "delay": "72h45m2s",
- "interval": "72h45m2s",
- "timeout": "72h45m2s",
- "restart": true
}, - "telemetry": {
- "retention": "72h45m2s",
- "interval": "72h45m2s",
- "disable": true
}
}, - "scale": {
- "autoscale_group": "string",
- "instances": {
- "max": 0,
- "max_server": 0,
- "min_ttl": "72h45m2s"
}, - "window": "72h45m2s",
- "thresholds": [
- {
- "type": null,
- "details": { }
}
]
}, - "runtime": {
- "command": {
- "path": "string",
- "args": "string"
}, - "namespaces": [
- "ipc"
], - "environment_vars": {
- "property1": "string",
- "property2": "string"
}, - "privileged": true,
- "capabilities": [
- "CAP_CHOWN"
], - "workdir": "string",
- "sysctl": {
- "property1": "string",
- "property2": "string"
}, - "rlimits": {
- "property1": {
- "hard": null,
- "soft": null
}, - "property2": {
- "hard": null,
- "soft": null
}
}, - "seccomp": {
- "disable": true,
- "rules": [
- null
]
}, - "host": {
- "expose_proc": true
}, - "rootfs": {
- "readonly": true
}, - "devices": {
- "shm_size": "64M"
}
}, - "resources": {
- "cpu": {
- "shares": {
- "limit": null,
- "reserve": null
}, - "cpus": "string"
}, - "ram": {
- "limit": "1G",
- "reserve": "string"
}
}, - "integrations": {
- "webhooks": {
- "events": {
- "deploy": null,
- "start": null,
- "stop": null
}, - "config": "string"
}, - "files": [
- {
- "source": null,
- "destination": null
}
], - "lets_encrypt": {
- "enable": true,
- "certificate_path": "string",
- "chain_path": "string",
- "key_path": "string",
- "bundle_path": "string",
- "additional_certs_path": "string"
}, - "backups": {
- "integration_id": "my-image-source",
- "backup": {
- "command": null,
- "timeout": null,
- "cron_string": null
}, - "restore": {
- "command": null,
- "timeout": null
}, - "retention": "365d"
}, - "shared_file_systems": {
- "property1": {
- "writable": null,
- "mount_point": null
}, - "property2": {
- "writable": null,
- "mount_point": null
}
}, - "logs": {
- "groups": [
- null
]
}
}
}, - "deployment": {
- "version": "v1.2.3-dev"
}, - "instances": 0,
- "volumes": [
- {
- "id": "651586fca6078e98982dbd90",
- "hash": "string",
- "config": {
- "read_only": true,
- "block_device": true,
- "local": {
- "max_size": null,
- "storage_pool": null
}, - "destination": "string",
- "remote_access": {
- "enable": null,
- "ips": [ ],
- "webhook": null,
- "password": { }
}
}
}
], - "annotations": {
- "property1": null,
- "property2": null
}, - "role": "orchestrator",
- "stateful": true,
- "deprecate": true,
- "lock": true,
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z",
- "started": "2021-01-30T08:30:00Z"
}, - "meta": {
- "instances_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "domains": [
- {
- "fqdn": "string",
- "record": {
- "id": null,
- "hub_id": null,
- "creator": null,
- "zone_id": null,
- "name": null,
- "resolved_domain": null,
- "type": null,
- "features": { },
- "state": null,
- "events": null
}
}
], - "ips": [
- {
- "id": "651586fca6078e98982dbd90",
- "hub_id": "651586fca6078e98982dbd90",
- "kind": "ipv4",
- "assignment": {
- "container_id": null,
- "instance_id": null,
- "environment_id": null
}, - "pool_id": "string",
- "address": "string",
- "gateway": "string",
- "cidr": "string",
- "state": {
- "changed": null,
- "error": { }
}
}
]
}
}, - "property2": {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "name": "string",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "environment": {
- "id": "651586fca6078e98982dbd90",
- "cluster": "string",
- "container_subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}
}
}, - "hub_id": "651586fca6078e98982dbd90",
- "image": {
- "id": "651586fca6078e98982dbd90",
- "extension": {
- "identifier": "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": null
}
}, - "constraints": {
- "node": {
- "tags": { }
}, - "secrets": [
- null
]
}, - "shutdown": {
- "graceful_timeout": "72h45m2s",
- "signals": [
- null
]
}, - "startup": {
- "delay": "72h45m2s"
}, - "update": {
- "stagger": "72h45m2s"
}, - "restart": {
- "condition": "always",
- "delay": "72h45m2s",
- "max_attempts": 0
}, - "health_check": {
- "command": "string",
- "retries": 0,
- "delay": "72h45m2s",
- "interval": "72h45m2s",
- "timeout": "72h45m2s",
- "restart": true
}, - "telemetry": {
- "retention": "72h45m2s",
- "interval": "72h45m2s",
- "disable": true
}
}, - "scale": {
- "autoscale_group": "string",
- "instances": {
- "max": 0,
- "max_server": 0,
- "min_ttl": "72h45m2s"
}, - "window": "72h45m2s",
- "thresholds": [
- {
- "type": null,
- "details": { }
}
]
}, - "runtime": {
- "command": {
- "path": "string",
- "args": "string"
}, - "namespaces": [
- "ipc"
], - "environment_vars": {
- "property1": "string",
- "property2": "string"
}, - "privileged": true,
- "capabilities": [
- "CAP_CHOWN"
], - "workdir": "string",
- "sysctl": {
- "property1": "string",
- "property2": "string"
}, - "rlimits": {
- "property1": {
- "hard": null,
- "soft": null
}, - "property2": {
- "hard": null,
- "soft": null
}
}, - "seccomp": {
- "disable": true,
- "rules": [
- null
]
}, - "host": {
- "expose_proc": true
}, - "rootfs": {
- "readonly": true
}, - "devices": {
- "shm_size": "64M"
}
}, - "resources": {
- "cpu": {
- "shares": {
- "limit": null,
- "reserve": null
}, - "cpus": "string"
}, - "ram": {
- "limit": "1G",
- "reserve": "string"
}
}, - "integrations": {
- "webhooks": {
- "events": {
- "deploy": null,
- "start": null,
- "stop": null
}, - "config": "string"
}, - "files": [
- {
- "source": null,
- "destination": null
}
], - "lets_encrypt": {
- "enable": true,
- "certificate_path": "string",
- "chain_path": "string",
- "key_path": "string",
- "bundle_path": "string",
- "additional_certs_path": "string"
}, - "backups": {
- "integration_id": "my-image-source",
- "backup": {
- "command": null,
- "timeout": null,
- "cron_string": null
}, - "restore": {
- "command": null,
- "timeout": null
}, - "retention": "365d"
}, - "shared_file_systems": {
- "property1": {
- "writable": null,
- "mount_point": null
}, - "property2": {
- "writable": null,
- "mount_point": null
}
}, - "logs": {
- "groups": [
- null
]
}
}
}, - "deployment": {
- "version": "v1.2.3-dev"
}, - "instances": 0,
- "volumes": [
- {
- "id": "651586fca6078e98982dbd90",
- "hash": "string",
- "config": {
- "read_only": true,
- "block_device": true,
- "local": {
- "max_size": null,
- "storage_pool": null
}, - "destination": "string",
- "remote_access": {
- "enable": null,
- "ips": [ ],
- "webhook": null,
- "password": { }
}
}
}
], - "annotations": {
- "property1": null,
- "property2": null
}, - "role": "orchestrator",
- "stateful": true,
- "deprecate": true,
- "lock": true,
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z",
- "started": "2021-01-30T08:30:00Z"
}, - "meta": {
- "instances_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "domains": [
- {
- "fqdn": "string",
- "record": {
- "id": null,
- "hub_id": null,
- "creator": null,
- "zone_id": null,
- "name": null,
- "resolved_domain": null,
- "type": null,
- "features": { },
- "state": null,
- "events": null
}
}
], - "ips": [
- {
- "id": "651586fca6078e98982dbd90",
- "hub_id": "651586fca6078e98982dbd90",
- "kind": "ipv4",
- "assignment": {
- "container_id": null,
- "instance_id": null,
- "environment_id": null
}, - "pool_id": "string",
- "address": "string",
- "gateway": "string",
- "cidr": "string",
- "state": {
- "changed": null,
- "error": { }
}
}
]
}
}
}
}
}
Requires the virtual-machines-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
}
}
]
}
}
}
Used to perform different actions on a virtual machine.
Requires the following capabilities based on the task:
start
: virtual-machines-manage
stop
: virtual-machines-manage
reconfigure
: virtual-machines-manage
rootpw.change
: virtual-machines-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
}
}
]
}
}
}
Retrieves the list of available base images for virtual machines provided by Cycle.
A map of virtual machine base images provided by Cycle keyed by an identifier.
General error response from the platform
{- "data": {
- "property1": {
- "title": "string",
- "description": "string",
- "versions": [
- {
- "identifier": "alpine-3-19",
- "version": 3.19,
- "supported": true,
- "uefi": true
}
]
}, - "property2": {
- "title": "string",
- "description": "string",
- "versions": [
- {
- "identifier": "alpine-3-19",
- "version": 3.19,
- "supported": true,
- "uefi": true
}
]
}
}
}
Generates credentials for connecting to the serial console of a virtual machine via SSH.
Requires the virtual-machines-console
capability.
Returns a serial-over-sos connection response.
General error response from the platform
{- "data": {
- "token": {
- "id": "651586fca6078e98982dbd90",
- "virtual_machine_id": "string",
- "hub_id": "651586fca6078e98982dbd90",
- "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "used": "2021-01-30T08:30:00Z",
- "expires": "2021-01-30T08:30:00Z"
}, - "valid": true
}, - "secret": "string",
- "address": "string"
}
}
Instantly expires any serial-over-SSH credentials generated for this virtual machine.
Requires the virtual-machines-console
capability.
Returns the number of tokens removed.
General error response from the platform
{- "data": {
- "tokens": 0
}
}