Servers

Endpoints related to managing servers on Cycle.

List Servers

Requires the servers-view capability.

SecuritybearerAuth and hubAuth

Request

query Parameters

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

default

General error response from the platform

get/v1/infrastructure/servers

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"location_id": "string",
"model_id": "string",
"node_id": "string",
"shared_file_systems": {"mounts": {"property1": {"type": "string",
"options": "key1=value1,key2=value2",
"source": "string"
},
"property2": {"type": "string",
"options": "key1=value1,key2=value2",
"source": "string"
}
},
"directories": {"property1": null,
"property2": null
}
},
"hostname": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"provider": {"vendor": "string",
"model": "string",
"location": "string",
"server": "string",
"init_ips": ["string"
],
"mac_addr": "string",
"extra": { },
"provision_options": {"attachesd_storage_size": 0,
"reservation_id": "string"
}
},
"cluster": "string",
"features": {"sftp": true,
"base_volume_gb": 0
},
"constraints": {"tags": ["string"
],
"allow": {"pool": true,
"services": true,
"overcommit": true
}
},
"autoscale": {"group_id": "651586fca6078e98982dbd90"
},
"ephemeral": true,
"evacuate": {"started": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"latest_instance": "2021-01-30T08:30:00Z",
"provisioning": {"started": "2021-01-30T08:30:00Z",
"failed": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
},
"meta": {"node": {"last_checkin": "2021-01-30T08:30:00Z",
"drivers": ["string"
],
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"stats": {"network": {"interfaces": {"property1": { },
"property2": { }
},
"external_ipv4": "string",
"external_ipv6": "string"
},
"uptime": {"seconds": 0,
"cpu_idle": 0
},
"cpu": {"cores": 0,
"processors": [{ }
],
"usage": {"user": null,
"nice": null,
"system": null,
"idle": null,
"iowait": null,
"irq": null,
"soft_irq": null,
"steal": null,
"guest": null,
"guest_nice": null
}
},
"load": {"avg1m": 0,
"avg5m": 0,
"avg15m": 0
},
"ram": {"available": 0,
"free": 0,
"total": 0
},
"storage": {"volume_groups": {"property1": { },
"property2": { }
},
"mounts": {"property1": { },
"property2": { }
}
},
"os": {"release": "string",
"kernel": "string",
"hostname": "string"
},
"versions": {"services": {"property1": null,
"property2": null
}
}
},
"healthy": true,
"online": true
},
"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"allocations": {"cpu_shares": {"total": 0,
"allocatable": 0,
"allocated": 0
},
"ram": {"total_mb": 0,
"allocatable_mb": 0,
"allocated_mb": 0
}
}
}
}
],
"includes": {"locations": {"property1": {"id": "string",
"name": "string",
"geographic": {"latitude": 0,
"longitude": 0,
"city": "string",
"state": "string",
"country": "string",
"region": "string"
},
"provider": {"identifier": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string",
"code": "string",
"availability_zones": ["string"
]
},
"compatible": true,
"features": {"available": ["string"
],
"supported": ["string"
]
},
"abbreviation": "string",
"annotations": {"property1": null,
"property2": null
}
},
"property2": {"id": "string",
"name": "string",
"geographic": {"latitude": 0,
"longitude": 0,
"city": "string",
"state": "string",
"country": "string",
"region": "string"
},
"provider": {"identifier": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string",
"code": "string",
"availability_zones": ["string"
]
},
"compatible": true,
"features": {"available": ["string"
],
"supported": ["string"
]
},
"abbreviation": "string",
"annotations": {"property1": null,
"property2": null
}
}
},
"models": {"property1": {"id": "651586fca6078e98982dbd90",
"name": "string",
"description": "string",
"specs": {"cpu": {"count": 0,
"cores": 0,
"threads": 0,
"type": "string",
"shared": true,
"extra": {"property1": "string",
"property2": "string"
}
},
"gpu": {"count": 0,
"cores": 0,
"vram_gb": 0,
"type": "string",
"shared": true,
"extra": {"property1": "string",
"property2": "string"
}
},
"memory": {"size_gb": 0,
"type": "string",
"extra": {"property1": "string",
"property2": "string"
}
},
"storage": [{"count": 0,
"size_gb": 0,
"type": "string",
"extra": {"property1": null,
"property2": null
}
}
],
"network": [{"count": 0,
"scope": "public",
"throughput": 0,
"type": "string"
}
],
"features": {"raid": "string",
"hypervisor": true,
"extra": { }
}
},
"provider": {"identifier": "string",
"integration_id": "651586fca6078e98982dbd90",
"category": "string",
"class": "string",
"model": "string",
"locations": ["string"
],
"availability_zones": {"property1": ["string"
],
"property2": ["string"
]
}
},
"price": {"mills": 0,
"term": "once"
},
"compatible": true,
"low_resource": true,
"location_ids": ["string"
]
},
"property2": {"id": "651586fca6078e98982dbd90",
"name": "string",
"description": "string",
"specs": {"cpu": {"count": 0,
"cores": 0,
"threads": 0,
"type": "string",
"shared": true,
"extra": {"property1": "string",
"property2": "string"
}
},
"gpu": {"count": 0,
"cores": 0,
"vram_gb": 0,
"type": "string",
"shared": true,
"extra": {"property1": "string",
"property2": "string"
}
},
"memory": {"size_gb": 0,
"type": "string",
"extra": {"property1": "string",
"property2": "string"
}
},
"storage": [{"count": 0,
"size_gb": 0,
"type": "string",
"extra": {"property1": null,
"property2": null
}
}
],
"network": [{"count": 0,
"scope": "public",
"throughput": 0,
"type": "string"
}
],
"features": {"raid": "string",
"hypervisor": true,
"extra": { }
}
},
"provider": {"identifier": "string",
"integration_id": "651586fca6078e98982dbd90",
"category": "string",
"class": "string",
"model": "string",
"locations": ["string"
],
"availability_zones": {"property1": ["string"
],
"property2": ["string"
]
}
},
"price": {"mills": 0,
"term": "once"
},
"compatible": true,
"low_resource": true,
"location_ids": ["string"
]
}
},
"integrations": {"property1": {"id": "651586fca6078e98982dbd90",
"name": "string",
"vendor": "string",
"identifier": "string",
"auth": {"region": "string",
"namespace": "string",
"api_key": "string",
"key_id": "string",
"secret": "string",
"subscription_id": "string",
"client_id": "string",
"base64_config": "string"
},
"extra": {"property1": "string",
"property2": "string"
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"meta": {"definition": {"vendor": "string",
"name": "string",
"supports_verification": true,
"supports_multiple": true,
"features": ["string"
],
"extends": ["string"
],
"extended_configuration": {"options": [{ }
]
},
"fields": {"extra": {"property1": { },
"property2": { }
},
"auth": {"property1": { },
"property2": { }
}
},
"url": "http://example.com",
"public": true,
"usable": true,
"editable": true
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"name": "string",
"vendor": "string",
"identifier": "string",
"auth": {"region": "string",
"namespace": "string",
"api_key": "string",
"key_id": "string",
"secret": "string",
"subscription_id": "string",
"client_id": "string",
"base64_config": "string"
},
"extra": {"property1": "string",
"property2": "string"
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"meta": {"definition": {"vendor": "string",
"name": "string",
"supports_verification": true,
"supports_multiple": true,
"features": ["string"
],
"extends": ["string"
],
"extended_configuration": {"options": [{ }
]
},
"fields": {"extra": {"property1": { },
"property2": { }
},
"auth": {"property1": { },
"property2": { }
}
},
"url": "http://example.com",
"public": true,
"usable": true,
"editable": true
}
}
}
}
}
}

Create Server

Requires the servers-provision capability.

SecuritybearerAuth and hubAuth

Request

Request Body schema: application/json

Parameters for creating a Server.

cluster required	string The existing or new cluster this infrastructure should be provisioned in.
required	Array of objects An array of servers to provision.

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/infrastructure/servers

Request samples

Payload

application/json

{"cluster": "string",
"servers": [{"integration_id": "651586fca6078e98982dbd90",
"model_id": "string",
"location_id": "string",
"quantity": 0,
"hostnames": ["string"
],
"advanced": [{"provision_options": {"attached_storage_size": 0,
"reservation_id": "string",
"encrypt_storage": true
},
"zone": "string"
}
]
}
]
}

Response samples

202
default

application/json

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

Get Server

Requires the servers-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

serverId

required

string

The ID for the given Server.

query Parameters

include

Array of strings

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

Items Enum: "locations" "models" "integrations"

Update Server

Requires the servers-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

serverId

required

string

The ID for the given Server.

Request Body schema: application/json

Parameters for updating a Server.

required

object

Server constriants.

Responses

200

Returns a Server.

default

General error response from the platform

patch/v1/infrastructure/servers/{serverId}

Request samples

Payload

application/json

{"constraints": {"tags": ["string"
],
"allow": {"pool": true,
"services": true,
"overcommit": true,
"overcommit_multiple": 0
}
}
}

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"location_id": "string",
"model_id": "string",
"node_id": "string",
"shared_file_systems": {"mounts": {"property1": {"type": "string",
"options": "key1=value1,key2=value2",
"source": "string"
},
"property2": {"type": "string",
"options": "key1=value1,key2=value2",
"source": "string"
}
},
"directories": {"property1": null,
"property2": null
}
},
"hostname": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"provider": {"vendor": "string",
"model": "string",
"location": "string",
"server": "string",
"init_ips": ["string"
],
"mac_addr": "string",
"extra": { },
"provision_options": {"attachesd_storage_size": 0,
"reservation_id": "string"
}
},
"cluster": "string",
"features": {"sftp": true,
"base_volume_gb": 0
},
"constraints": {"tags": ["string"
],
"allow": {"pool": true,
"services": true,
"overcommit": true
}
},
"autoscale": {"group_id": "651586fca6078e98982dbd90"
},
"ephemeral": true,
"evacuate": {"started": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"latest_instance": "2021-01-30T08:30:00Z",
"provisioning": {"started": "2021-01-30T08:30:00Z",
"failed": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
},
"meta": {"node": {"last_checkin": "2021-01-30T08:30:00Z",
"drivers": ["string"
],
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"stats": {"network": {"interfaces": {"property1": {"interface": null,
"flags": null,
"mtu": null,
"mac_addr": null,
"addrs": [ ]
},
"property2": {"interface": null,
"flags": null,
"mtu": null,
"mac_addr": null,
"addrs": [ ]
}
},
"external_ipv4": "string",
"external_ipv6": "string"
},
"uptime": {"seconds": 0,
"cpu_idle": 0
},
"cpu": {"cores": 0,
"processors": [{"model": null,
"speed": null
}
],
"usage": {"user": 0,
"nice": 0,
"system": 0,
"idle": 0,
"iowait": 0,
"irq": 0,
"soft_irq": 0,
"steal": 0,
"guest": 0,
"guest_nice": 0
}
},
"load": {"avg1m": 0,
"avg5m": 0,
"avg15m": 0
},
"ram": {"available": 0,
"free": 0,
"total": 0
},
"storage": {"volume_groups": {"property1": {"name": null,
"size": null,
"volumes": { }
},
"property2": {"name": null,
"size": null,
"volumes": { }
}
},
"mounts": {"property1": {"device": null,
"type": null,
"mountpoint": null,
"total": null,
"free": null,
"used": null
},
"property2": {"device": null,
"type": null,
"mountpoint": null,
"total": null,
"free": null,
"used": null
}
}
},
"os": {"release": "string",
"kernel": "string",
"hostname": "string"
},
"versions": {"services": {"property1": "string",
"property2": "string"
}
}
},
"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
}
}
}
}
}

Delete Server

Requires the servers-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

serverId

required

string

The ID of the Server.

query Parameters

object

The option field is a key-value object, where the key is the option, and the value is a boolean. For example, ?option[force]=true

Responses

200

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/infrastructure/servers/{serverId}

Response samples

200
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 Server Telemetry

This call requires the filter query parameter to be used.

Requires the servers-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

serverId

required

string

The ID for the given Server.

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.
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 telemetry points.

default

General error response from the platform

get/v1/infrastructure/servers/{serverId}/telemetry

Response samples

200
default

application/json

{"data": [{"time": "2021-01-30T08:30:00Z",
"cpu_usage": {"user": 0,
"nice": 0,
"system": 0,
"idle": 0,
"iowait": 0,
"irq": 0,
"soft_irq": 0,
"steal": 0,
"guest": 0,
"guest_nice": 0
},
"load": {"avg1m": 0,
"avg5m": 0,
"avg15m": 0
},
"ram": {"available": 0,
"free": 0,
"total": 0
},
"storage_base": {"used": 0,
"free": 0,
"total": 0
},
"storage_pool": {"data_percent": 0,
"meta_percent": 0,
"total": 0
}
}
]
}

List Server Instances

Requires the containers-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

serverId

required

string

The ID for the given server.

query Parameters

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

include

Array of strings

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

Responses

200

Returns a list of Instances present on this Server.

default

General error response from the platform

get/v1/infrastructure/servers/{serverId}/instances

Response samples

200
default

application/json

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

Create Server Job

Used to perform different actions on a given Server. Requires the servers-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

serverId

required

string

The ID for the given Server.

Request Body schema: application/json

Parameters for creating the new Server Job.

action required	string The action to take. sharedfs.reconfigure
required	object

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/infrastructure/servers/{serverId}/tasks

Request samples

Payload

application/json

{"action": "sharedfs.reconfigure",
"contents": {"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
}
}
}

Response samples

202
default

application/json

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

List Server Tags

Requires the servers-view 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.

Responses

200

Returns a list of Server Tags.

default

General error response from the platform

get/v1/infrastructure/servers/tags

Response samples

200
default

application/json

{"data": ["string"
]
}

Get Server Usage

Requires the servers-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

serverId

required

string

The ID for the given server.

Responses

200

Returns usage data for the Server.

default

General error response from the platform

get/v1/infrastructure/servers/{serverId}/usage

Response samples

200
default

application/json

{"data": {"time": "2021-01-30T08:30:00Z",
"nodes": 0,
"memory_gb": 0
}
}

Get Server Console

Gets the authorization information required to connect to a Server console websocket.

Requires the servers-console capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

serverId

required

string

The ID of the server to connect to.

Responses

200

Returns console credentials for the Server.

default

General error response from the platform

get/v1/infrastructure/servers/{serverId}/console

Response samples

200
default

application/json

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

➔ Next to IPs