Virtual Machines

Endpoints for managing virtual machines.

List Virtual Machines

Requires the virtual-machines-view capability.

SecuritybearerAuth and hubAuth

Request

query Parameters

meta	Array of strings A comma-separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. Items Enum: "domains" "ips"
include	Array of strings A comma-separated list of include values. Included resources will show up under the root document's `include` field. In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return. Items Enum: "creators" "environments" "clusters" "containers"
	object Filter Field The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
sort	Array of strings An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	object In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`

Responses

200

Returns a list of virtual machines.

default

General error response from the platform

get/v1/virtual-machines

Response samples

200
default

application/json

{"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"
},
"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"
},
"ssh_keys": ["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",
"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": "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
}
}
}
],
"server": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"location_id": "string",
"model_id": "string",
"node_id": "string",
"shared_file_systems": {"mounts": {"property1": {"type": null,
"options": null,
"source": null
},
"property2": {"type": null,
"options": null,
"source": null
}
},
"directories": {"property1": null,
"property2": null
}
},
"hostname": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"provider": {"vendor": "string",
"integration_id": "651586fca6078e98982dbd90",
"model": "string",
"zone": "string",
"location": "string",
"server": "string",
"init_ips": ["string"
],
"mac_addr": "string",
"extra": { },
"provision_options": {"encrypt_storage": true,
"storage_size": 0,
"reservation_id": "string"
}
},
"cluster": "string",
"features": {"sftp": true,
"base_volume_gb": 0,
"gateway": {"type": "bgp"
}
},
"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": [null
],
"state": {"changed": null,
"error": { }
},
"stats": {"network": null,
"uptime": null,
"cpu": null,
"load": null,
"ram": null,
"storage": null,
"os": null,
"versions": 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": null,
"allocatable": null,
"allocated": null
},
"ram": {"total_mb": null,
"allocatable_mb": null,
"allocated_mb": 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": [ ]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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": [ ]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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
]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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
]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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": {"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": {"drain": {"url": 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,
"virtual_machine": { }
},
"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": {"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": {"drain": {"url": 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,
"virtual_machine": { }
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": null,
"error": { }
}
}
]
}
}
}
}
}

Create Virtual Machine

Requires the virtual-machines-deploy capability.

SecuritybearerAuth and hubAuth

Request

query Parameters

meta	Array of strings A comma-separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. Items Enum: "domains" "ips" "server"
include	Array of strings A comma-separated list of include values. Included resources will show up under the root document's `include` field. In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return. Items Enum: "creators" "environments" "clusters"

Request Body schema: application/json

Parameters for creating a new virtual machine.

identifier	string (Identifier) A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient. The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will have the identifier of `my-container` and is automatically created by the platform. The identifier does not have to be unique.
name required	string A user-defined name for the virtual machine.
environment_id required	string The ID of the environment this virtual machine will be deployed to.
required	VirtualMachineImage (object) or VirtualMachineImage (object) or VirtualMachineImage (object) (VirtualMachineImage)
required	object (VirtualMachineConfig) Defines the network and deployment configurations for a virtual machine.
lock required	boolean Prevents this virtual machine from being deleted when true.
	Array of VirtualMachineVolumeConfig (objects) or null
base_disk_size	string The size of the base disk. Must be between 10G and 100G.
	object or null Custom meta data. Not utilized by Cycle.
ssh_keys	Array of strings <objectid> (ID) An array of SSH key IDs that should be applied to this virtual machine.

Responses

201

Returns the newly created virtual machine.

default

General error response from the platform

post/v1/virtual-machines

Request samples

Payload

application/json

{"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"
},
"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
},
"ssh_keys": ["651586fca6078e98982dbd90"
]
}

Response samples

201
default

application/json

{"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"
},
"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"
},
"ssh_keys": ["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",
"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,
"user_supplied": null,
"expires": 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"
}
}
}
],
"server": {"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",
"integration_id": "651586fca6078e98982dbd90",
"model": "string",
"zone": "string",
"location": "string",
"server": "string",
"init_ips": ["string"
],
"mac_addr": "string",
"extra": { },
"provision_options": {"encrypt_storage": true,
"storage_size": 0,
"reservation_id": "string"
}
},
"cluster": "string",
"features": {"sftp": true,
"base_volume_gb": 0,
"gateway": {"type": "bgp"
}
},
"constraints": {"tags": ["string"
],
"allow": {"pool": true,
"services": true,
"overcommit": true
}
},
"autoscale": {"group_id": "651586fca6078e98982dbd90"
},
"ephemeral": true,
"evacuate": {"started": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"latest_instance": "2021-01-30T08:30:00Z",
"provisioning": {"started": "2021-01-30T08:30:00Z",
"failed": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
},
"meta": {"node": {"last_checkin": "2021-01-30T08:30:00Z",
"drivers": ["string"
],
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
},
"stats": {"network": {"interfaces": { },
"external_ipv4": null,
"external_ipv6": null
},
"uptime": {"seconds": null,
"cpu_idle": null
},
"cpu": {"cores": null,
"processors": [ ],
"usage": null
},
"load": {"avg1m": null,
"avg5m": null,
"avg15m": null
},
"ram": {"available": null,
"free": null,
"total": null
},
"storage": {"volume_groups": { },
"mounts": { }
},
"os": {"release": null,
"kernel": null,
"hostname": null
},
"versions": {"services": { }
}
},
"healthy": true,
"online": true
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"allocations": {"cpu_shares": {"total": 0,
"allocatable": 0,
"allocated": 0
},
"ram": {"total_mb": 0,
"allocatable_mb": 0,
"allocated_mb": 0
}
}
}
}
}
},
"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": [ ]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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": [ ]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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
]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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
]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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": {"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": {"drain": {"url": 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,
"virtual_machine": { }
},
"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": {"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": {"drain": {"url": 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,
"virtual_machine": { }
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": null,
"error": { }
}
}
]
}
}
}
}
}

Get Virtual Machine

Retrieves a single virtual machine by ID.

Requires the virtual-machines-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

virtualMachineId

required

string

The ID of the virtual machine.

query Parameters

meta	Array of strings A comma-separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. Items Enum: "domains" "ips" "server"
include	Array of strings A comma-separated list of include values. Included resources will show up under the root document's `include` field. In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return. Items Enum: "creators" "environments" "clusters" "containers"

Responses

200

Returns the requested virtual machine.

default

General error response from the platform

get/v1/virtual-machines/{virtualMachineId}

Response samples

200
default

application/json

{"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"
},
"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"
},
"ssh_keys": ["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",
"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,
"user_supplied": null,
"expires": 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"
}
}
}
],
"server": {"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",
"integration_id": "651586fca6078e98982dbd90",
"model": "string",
"zone": "string",
"location": "string",
"server": "string",
"init_ips": ["string"
],
"mac_addr": "string",
"extra": { },
"provision_options": {"encrypt_storage": true,
"storage_size": 0,
"reservation_id": "string"
}
},
"cluster": "string",
"features": {"sftp": true,
"base_volume_gb": 0,
"gateway": {"type": "bgp"
}
},
"constraints": {"tags": ["string"
],
"allow": {"pool": true,
"services": true,
"overcommit": true
}
},
"autoscale": {"group_id": "651586fca6078e98982dbd90"
},
"ephemeral": true,
"evacuate": {"started": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"latest_instance": "2021-01-30T08:30:00Z",
"provisioning": {"started": "2021-01-30T08:30:00Z",
"failed": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
},
"meta": {"node": {"last_checkin": "2021-01-30T08:30:00Z",
"drivers": ["string"
],
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
},
"stats": {"network": {"interfaces": { },
"external_ipv4": null,
"external_ipv6": null
},
"uptime": {"seconds": null,
"cpu_idle": null
},
"cpu": {"cores": null,
"processors": [ ],
"usage": null
},
"load": {"avg1m": null,
"avg5m": null,
"avg15m": null
},
"ram": {"available": null,
"free": null,
"total": null
},
"storage": {"volume_groups": { },
"mounts": { }
},
"os": {"release": null,
"kernel": null,
"hostname": null
},
"versions": {"services": { }
}
},
"healthy": true,
"online": true
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"allocations": {"cpu_shares": {"total": 0,
"allocatable": 0,
"allocated": 0
},
"ram": {"total_mb": 0,
"allocatable_mb": 0,
"allocated_mb": 0
}
}
}
}
}
},
"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": [ ]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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": [ ]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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
]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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
]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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": {"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": {"drain": {"url": 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,
"virtual_machine": { }
},
"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": {"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": {"drain": {"url": 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,
"virtual_machine": { }
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": null,
"error": { }
}
}
]
}
}
}
}
}

Delete Virtual Machine

Requires the virtual-machines-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

virtualMachineId

required

string

The ID of the virtual machine to delete.

Responses

202

Returns a job descriptor.

default

General error response from the platform

delete/v1/virtual-machines/{virtualMachineId}

Response samples

202
default

application/json

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

Create Virtual Machine Job

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 ip.allocate: virtual-machines-manage ip.unallocate: virtual-machines-manage

SecuritybearerAuth and hubAuth

Request

path Parameters

virtualMachineId

required

string

The ID of the virtual machine.

Request Body schema: application/json

Parameters for creating a new virtual machine job.

action

required

string

Responses

202

Returns a job descriptor.

default

General error response from the platform

post/v1/virtual-machines/{virtualMachineId}/tasks

Request samples

Payload

application/json

{"action": "start"
}

Response samples

202
default

application/json

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

Get Virtual Machine Base Images

Retrieves the list of available base images for virtual machines provided by Cycle.

SecuritybearerAuth and hubAuth

Responses

200

A map of virtual machine base images provided by Cycle keyed by an identifier.

default

General error response from the platform

get/v1/virtual-machines/images/base

Response samples

200
default

application/json

{"data": {"property1": {"title": "string",
"description": "string",
"homepage": "http://example.com",
"versions": [{"identifier": "alpine-3-19",
"version": 3.19,
"disk_image_url": "http://example.com",
"supported": true,
"uefi": true
}
]
},
"property2": {"title": "string",
"description": "string",
"homepage": "http://example.com",
"versions": [{"identifier": "alpine-3-19",
"version": 3.19,
"disk_image_url": "http://example.com",
"supported": true,
"uefi": true
}
]
}
}
}

Generate Virtual Machine Serial-Over-SSH Credentials

Generates credentials for connecting to the serial console of a virtual machine via SSH.

Requires the virtual-machines-console capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

virtualMachineId

required

string

The ID of the virtual machine.

Responses

200

Returns a serial-over-sos connection response.

default

General error response from the platform

get/v1/virtual-machines/{virtualMachineId}/sos

Response samples

200
default

application/json

{"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"
}
}

Expire Serial-Over-SSH Credentials

Instantly expires any serial-over-SSH credentials generated for this virtual machine.

Requires the virtual-machines-console capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

virtualMachineId

required

string

The ID of the virtual machine.

Responses

200

Returns the number of tokens removed.

default

General error response from the platform

delete/v1/virtual-machines/{virtualMachineId}/sos

Response samples

200
default

application/json

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

List Virtual Machine SSH Keys

Requires the virtual-machines-ssh-keys-manage capability.

SecuritybearerAuth and hubAuth

Request

query Parameters

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

Responses

200

Returns a list of virtual machine SSH keys.

default

General error response from the platform

get/v1/virtual-machines/ssh-keys

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"name": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"environment_id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"public_key": "string"
}
],
"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": [ ]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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": [ ]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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
]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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
]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"private_network": {"vxlan_tag": 0,
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"deployments": {"tags": {"property1": "v1.2.3-dev",
"property2": "v1.2.3-dev"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"containers": [{"id": "651586fca6078e98982dbd90",
"name": "string",
"state": {"changed": null,
"error": { }
},
"image": {"id": null,
"service": null
},
"environment": {"id": null,
"cluster": null,
"container_subnet": null,
"ipv6": null,
"legacy": null
}
}
]
}
}
},
"environments:identifiers": {"property1": "651586fca6078e98982dbd90",
"property2": "651586fca6078e98982dbd90"
}
}
}

Create Virtual Machine SSH Key

Requires the virtual-machines-ssh-keys-manage capability.

SecuritybearerAuth and hubAuth

Request

query Parameters

include

Array of strings

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

Items Enum: "creators" "environments"

Request Body schema: application/json

Parameters for creating a new virtual machine SSH key.

name required	string A user-defined name for the SSH key.
public_key required	string The public key of the SSH key.
environment_id required	string <objectid> (ID) A 24 character hex string used to identify a unique resource.

Responses

201

Returns the newly created SSH key.

default

General error response from the platform

post/v1/virtual-machines/ssh-keys

Request samples

Payload

application/json

{"name": "string",
"public_key": "string",
"environment_id": "651586fca6078e98982dbd90"
}

Response samples

201
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"name": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"environment_id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"public_key": "string"
},
"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": [ ]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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": [ ]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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
]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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
]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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"
}
}
}

Get Virtual Machine SSH Key

Retrieves a single virtual machine SSH key by ID.

Requires the virtual-machines-ssh-keys-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

sshKeyId

required

string

The ID of the virtual machine SSH key.

query Parameters

include

Array of strings

Items Enum: "creators" "environments"

Responses

200

Returns the requested virtual machine SSH key.

default

General error response from the platform

get/v1/virtual-machines/ssh-keys/{sshKeyId}

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"name": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"environment_id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"public_key": "string"
},
"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": [ ]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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": [ ]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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
]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"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
]
}
},
"gateway": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true
}
},
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"private_network": {"vxlan_tag": 0,
"subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"deployments": {"tags": {"property1": "v1.2.3-dev",
"property2": "v1.2.3-dev"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"containers": [{"id": "651586fca6078e98982dbd90",
"name": "string",
"state": {"changed": null,
"error": { }
},
"image": {"id": null,
"service": null
},
"environment": {"id": null,
"cluster": null,
"container_subnet": null,
"ipv6": null,
"legacy": null
}
}
]
}
}
},
"environments:identifiers": {"property1": "651586fca6078e98982dbd90",
"property2": "651586fca6078e98982dbd90"
}
}
}

Delete Virtual Machine SSH Key

Requires the virtual-machines-ssh-keys-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

sshKeyId

required

string

The ID of the virtual machine SSH key to delete.

Responses

202

Returns a job descriptor.

default

General error response from the platform

delete/v1/virtual-machines/ssh-keys/{sshKeyId}

Response samples

202
default

application/json

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

➔ Next to Utility

Virtual Machines

List Virtual Machines

query Parameters

Filter Field

Create Virtual Machine

query Parameters

Request Body schema: application/json

Get Virtual Machine

path Parameters

query Parameters

Delete Virtual Machine

path Parameters

Create Virtual Machine Job

path Parameters

Request Body schema: application/json

Get Virtual Machine Base Images

Generate Virtual Machine Serial-Over-SSH Credentials

path Parameters

Expire Serial-Over-SSH Credentials

path Parameters

List Virtual Machine SSH Keys

query Parameters

Filter Field

Create Virtual Machine SSH Key

query Parameters

Request Body schema: application/json

Get Virtual Machine SSH Key

path Parameters

query Parameters

Delete Virtual Machine SSH Key

path Parameters