Cycle Internal API (1.0.0)

Download OpenAPI specification:Download

E-mail: support@cycle.io License: Apache-2.0

Inside every container running on Cycle, there is a Unix socket mounted at /var/run/cycle/api/api.sock. You can send HTTP requests over this socket to access information about the local environment, access secrets, and much more. The way this internal API functions is very similar to how Cycle's main API works, though the purpose is different. The internal API is primarily used by instances to learn about their environment, and dynamically update as deployments change. In the future, we expect you'll be able to use the internal API to register service containers and much more. The internal API returns identical JSON responses to the main API. There is also a websocket based API that you can tune into for streaming platform updates.

Environments

Get Environment

Gets the Environment that this instance is a part of.

SecuritytokenAuth

Responses

200

Returns an Environment.

default

General error response from the platform

get/v1/environment

Response samples

200
default

application/json

{"data": {"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": [{"identifier": null,
"port": null,
"waf": null,
"transport": { }
}
],
"controller_template": {"identifier": "string",
"port": 0,
"waf": {"rules": [ ]
},
"transport": {"disable": null,
"mode": null,
"config": { },
"routers": [ ]
}
},
"waf": {"rules": [{ }
]
}
},
"bind_host": true
}
},
"discovery": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"empty_set_delay": "72h45m2s",
"hosts": {"property1": {"ipv4": [null
],
"ipv6": [null
]
},
"property2": {"ipv4": [null
],
"ipv6": [null
]
}
},
"custom_resolvers": ["string"
]
}
},
"vpn": {"enable": true,
"container_id": "string",
"auto_update": true,
"config": {"allow_internet": true,
"auth": {"webhook": "string",
"cycle_accounts": true,
"vpn_accounts": true
}
}
},
"scheduler": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"public": true,
"access_keys": [{"name": "string",
"secret": "string",
"ips": [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": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"image": {"id": "651586fca6078e98982dbd90",
"service": "discovery"
},
"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": null,
"cidr": null
}
}
}
}
]
}
}
}

List Environment Containers

Lists all Containers that are part of the same Environment as this Instance.

SecuritytokenAuth

Responses

200

Returns a collection of container resources.

default

General error response from the platform

get/v1/environment/containers

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"environment": {"id": "651586fca6078e98982dbd90",
"cluster": "string",
"container_subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"hub_id": "651586fca6078e98982dbd90",
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "virtual-machine-v1",
"id": "651586fca6078e98982dbd90"
},
"service": "discovery"
},
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": ["string"
]
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": 0,
"max_shard_concurrency": 0,
"max_runtime": "72h45m2s",
"max_queue_time": "72h45m2s"
},
"stateful": {"options": {"use_base_hostname": true
}
},
"constraints": {"node": {"tags": {"any": [ ],
"all": [ ]
}
},
"secrets": ["string"
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": ["SIGTERM"
]
},
"startup": {"delay": "72h45m2s"
},
"update": {"stagger": "72h45m2s"
},
"restart": {"condition": "always",
"delay": "72h45m2s",
"max_attempts": 0
},
"health_check": {"command": "string",
"retries": 0,
"delay": "72h45m2s",
"interval": "72h45m2s",
"timeout": "72h45m2s",
"restart": true
},
"telemetry": {"retention": "72h45m2s",
"interval": "72h45m2s",
"disable": true
}
},
"scale": {"autoscale_group": "string",
"instances": {"max": 0,
"max_server": 0,
"min_ttl": "72h45m2s"
},
"window": "72h45m2s",
"thresholds": [{"type": "ram",
"details": {"usage": null
}
}
]
},
"runtime": {"command": {"path": "string",
"args": "string"
},
"namespaces": ["ipc"
],
"environment_vars": {"property1": "string",
"property2": "string"
},
"privileged": true,
"capabilities": ["CAP_CHOWN"
],
"workdir": "string",
"sysctl": {"property1": "string",
"property2": "string"
},
"rlimits": {"property1": {"hard": 0,
"soft": 0
},
"property2": {"hard": 0,
"soft": 0
}
},
"seccomp": {"disable": true,
"rules": [{"capabilities": { },
"syscall": { }
}
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M"
}
},
"resources": {"cpu": {"shares": {"limit": 0,
"reserve": 0
},
"cpus": "string"
},
"ram": {"limit": "1G",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": "string",
"start": "string",
"stop": "string"
},
"config": "string"
},
"files": [{"source": "string",
"destination": "string"
}
],
"lets_encrypt": {"enable": true,
"certificate_path": "string",
"chain_path": "string",
"key_path": "string",
"bundle_path": "string",
"additional_certs_path": "string"
},
"backups": {"integration_id": "my-image-source",
"backup": {"command": "string",
"timeout": "72h45m2s",
"cron_string": "string"
},
"restore": {"command": "string",
"timeout": "72h45m2s"
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": true,
"mount_point": "string"
},
"property2": {"writable": true,
"mount_point": "string"
}
},
"logs": {"groups": ["string"
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"config": {"read_only": true,
"block_device": true,
"local": {"max_size": "10G",
"storage_pool": true
},
"destination": "string",
"remote_access": {"enable": true,
"ips": [null
],
"webhook": "string",
"password": {"algorithm": null,
"data": null
}
}
}
}
],
"annotations": {"property1": null,
"property2": null
},
"role": "orchestrator",
"stateful": true,
"deprecate": true,
"lock": true,
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"started": "2021-01-30T08:30:00Z"
},
"meta": {"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"domains": [{"fqdn": "string",
"record": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": null,
"type": null
},
"zone_id": "string",
"name": "string",
"resolved_domain": "string",
"type": {"a": { },
"aaaa": { },
"cname": { },
"ns": { },
"mx": { },
"txt": { },
"alias": { },
"srv": { },
"caa": { },
"linked": { }
},
"features": {"certificate": null
},
"state": {"changed": null,
"error": { }
},
"events": {"property1": null,
"property2": null
}
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": "651586fca6078e98982dbd90",
"instance_id": "651586fca6078e98982dbd90",
"environment_id": "651586fca6078e98982dbd90",
"virtual_machine": {"id": null
}
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
}
}
]
}
}
]
}

List Environment Instances

Lists all Instances present in this Instance's Environment.

SecuritytokenAuth

Responses

200

Returns a list of Instances.

default

General error response from the platform

get/v1/environment/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"
}
}
]
}

List Environment IPs

Lists the IPs associated with this Instance's Environment.

SecuritytokenAuth

Responses

200

Returns a list of detailed IP objects.

default

General error response from the platform

get/v1/environment/ips

Response samples

200
default

application/json

{"data": [{"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"
}
}
}
]
}

List Environment Services

Lists the services containers/instances that are in the same environment as this instance.

SecuritytokenAuth

Responses

200

Returns a list of environment services (a combination of container and instance details).

default

General error response from the platform

get/v1/environment/services

Response samples

200
default

application/json

{"data": {"discovery": {"container": {"id": "651586fca6078e98982dbd90",
"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",
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "virtual-machine-v1",
"id": "651586fca6078e98982dbd90"
},
"service": "discovery"
},
"annotations": {"property1": null,
"property2": null
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"role": "contductor",
"deprecate": true,
"deployment": {"version": "v1.2.3-dev"
},
"lock": true,
"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"
}
},
"instances": [{"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": null,
"cidr": null
}
},
"mac_addr": "string",
"vxlan_tag": 0
},
"stateful": {"id": "651586fca6078e98982dbd90",
"base_hostname": "string"
},
"autoscale": {"min_ttl": "2021-01-30T08:30:00Z"
},
"provider": {"vendor": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string"
},
"server_id": "651586fca6078e98982dbd90",
"ready_state": "active",
"deployment": {"version": "v1.2.3-dev"
},
"hostname": "string",
"service": "discovery",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
]
},
"vpn": {"container": {"id": "651586fca6078e98982dbd90",
"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",
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "virtual-machine-v1",
"id": "651586fca6078e98982dbd90"
},
"service": "discovery"
},
"annotations": {"property1": null,
"property2": null
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"role": "contductor",
"deprecate": true,
"deployment": {"version": "v1.2.3-dev"
},
"lock": true,
"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"
}
},
"instances": [{"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": null,
"cidr": null
}
},
"mac_addr": "string",
"vxlan_tag": 0
},
"stateful": {"id": "651586fca6078e98982dbd90",
"base_hostname": "string"
},
"autoscale": {"min_ttl": "2021-01-30T08:30:00Z"
},
"provider": {"vendor": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string"
},
"server_id": "651586fca6078e98982dbd90",
"ready_state": "active",
"deployment": {"version": "v1.2.3-dev"
},
"hostname": "string",
"service": "discovery",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
]
},
"loadbalancer": {"container": {"id": "651586fca6078e98982dbd90",
"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",
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "virtual-machine-v1",
"id": "651586fca6078e98982dbd90"
},
"service": "discovery"
},
"annotations": {"property1": null,
"property2": null
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"role": "contductor",
"deprecate": true,
"deployment": {"version": "v1.2.3-dev"
},
"lock": true,
"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"
}
},
"instances": [{"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": null,
"cidr": null
}
},
"mac_addr": "string",
"vxlan_tag": 0
},
"stateful": {"id": "651586fca6078e98982dbd90",
"base_hostname": "string"
},
"autoscale": {"min_ttl": "2021-01-30T08:30:00Z"
},
"provider": {"vendor": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string"
},
"server_id": "651586fca6078e98982dbd90",
"ready_state": "active",
"deployment": {"version": "v1.2.3-dev"
},
"hostname": "string",
"service": "discovery",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
]
},
"scheduler": {"container": {"id": "651586fca6078e98982dbd90",
"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",
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "virtual-machine-v1",
"id": "651586fca6078e98982dbd90"
},
"service": "discovery"
},
"annotations": {"property1": null,
"property2": null
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"role": "contductor",
"deprecate": true,
"deployment": {"version": "v1.2.3-dev"
},
"lock": true,
"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"
}
},
"instances": [{"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": null,
"cidr": null
}
},
"mac_addr": "string",
"vxlan_tag": 0
},
"stateful": {"id": "651586fca6078e98982dbd90",
"base_hostname": "string"
},
"autoscale": {"min_ttl": "2021-01-30T08:30:00Z"
},
"provider": {"vendor": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string"
},
"server_id": "651586fca6078e98982dbd90",
"ready_state": "active",
"deployment": {"version": "v1.2.3-dev"
},
"hostname": "string",
"service": "discovery",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
]
},
"property1": {"container": {"id": "651586fca6078e98982dbd90",
"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",
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "virtual-machine-v1",
"id": "651586fca6078e98982dbd90"
},
"service": "discovery"
},
"annotations": {"property1": null,
"property2": null
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"role": "contductor",
"deprecate": true,
"deployment": {"version": "v1.2.3-dev"
},
"lock": true,
"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"
}
},
"instances": [{"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": null,
"cidr": null
}
},
"mac_addr": "string",
"vxlan_tag": 0
},
"stateful": {"id": "651586fca6078e98982dbd90",
"base_hostname": "string"
},
"autoscale": {"min_ttl": "2021-01-30T08:30:00Z"
},
"provider": {"vendor": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string"
},
"server_id": "651586fca6078e98982dbd90",
"ready_state": "active",
"deployment": {"version": "v1.2.3-dev"
},
"hostname": "string",
"service": "discovery",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
]
},
"property2": {"container": {"id": "651586fca6078e98982dbd90",
"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",
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "virtual-machine-v1",
"id": "651586fca6078e98982dbd90"
},
"service": "discovery"
},
"annotations": {"property1": null,
"property2": null
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"role": "contductor",
"deprecate": true,
"deployment": {"version": "v1.2.3-dev"
},
"lock": true,
"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"
}
},
"instances": [{"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": null,
"cidr": null
}
},
"mac_addr": "string",
"vxlan_tag": 0
},
"stateful": {"id": "651586fca6078e98982dbd90",
"base_hostname": "string"
},
"autoscale": {"min_ttl": "2021-01-30T08:30:00Z"
},
"provider": {"vendor": "string",
"integration_id": "651586fca6078e98982dbd90",
"location": "string"
},
"server_id": "651586fca6078e98982dbd90",
"ready_state": "active",
"deployment": {"version": "v1.2.3-dev"
},
"hostname": "string",
"service": "discovery",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
]
}
}
}

Submit Environment Load Balancer Telemetry

Submit load balancer telemetry data.

SecuritytokenAuth

Request

Request Body schema: application/json
required

additional property

object (LoadBalancerTelemetrySnapshot)

Responses

200

Returns a list of Instances.

default

General error response from the platform

post/v1/environment/services/lb/telemetry/snapshots

Request samples

Payload

application/json

{"property1": {"time": "2021-01-30T08:30:00Z",
"started": "2021-01-30T08:30:00Z",
"version": "string",
"dataset_id": 0,
"current": {"router": {"destinations": {"property1": {"connections": {"success": 0,
"unavailable": 0,
"errors": {"property1": null,
"property2": null
},
"bytes_transmitted": 0,
"bytes_received": 0
},
"requests": {"total": 0,
"responses": {"property1": null,
"property2": null
},
"errors": {"property1": null,
"property2": null
}
},
"latency_ms": [0
],
"instance_id": "string",
"container_id": "string"
},
"property2": {"connections": {"success": 0,
"unavailable": 0,
"errors": {"property1": null,
"property2": null
},
"bytes_transmitted": 0,
"bytes_received": 0
},
"requests": {"total": 0,
"responses": {"property1": null,
"property2": null
},
"errors": {"property1": null,
"property2": null
}
},
"latency_ms": [0
],
"instance_id": "string",
"container_id": "string"
}
}
},
"urls": {"destinations": {"property1": {"requests": {"host": "abc.cycle.io",
"method": "GET",
"path": "/pathname",
"total": 5,
"last_hit": "2021-01-30T08:30:00Z",
"handlers": {"proxy": null,
"cache": null,
"forward": null,
"redirect": null
},
"responses": {"http:404": 10
},
"errors": {"i/o timeout": 1
}
}
},
"property2": {"requests": {"host": "abc.cycle.io",
"method": "GET",
"path": "/pathname",
"total": 5,
"last_hit": "2021-01-30T08:30:00Z",
"handlers": {"proxy": null,
"cache": null,
"forward": null,
"redirect": null
},
"responses": {"http:404": 10
},
"errors": {"i/o timeout": 1
}
}
}
}
},
"metrics": {"disconnects": {"no_error": 0,
"request_invalid": 0,
"timeout_idle": 0,
"router_none": 0,
"router_nomatch": 0,
"destination_unavailable": 0,
"unknown_error": 0
},
"connections": 0,
"requests": 0,
"bytes_transmitted": 0,
"bytes_received": 0
}
},
"cumulative": {"router": {"destinations": {"property1": {"connections": {"success": 0,
"unavailable": 0,
"errors": {"property1": null,
"property2": null
},
"bytes_transmitted": 0,
"bytes_received": 0
},
"requests": {"total": 0,
"responses": {"property1": null,
"property2": null
},
"errors": {"property1": null,
"property2": null
}
},
"latency_ms": [0
],
"instance_id": "string",
"container_id": "string"
},
"property2": {"connections": {"success": 0,
"unavailable": 0,
"errors": {"property1": null,
"property2": null
},
"bytes_transmitted": 0,
"bytes_received": 0
},
"requests": {"total": 0,
"responses": {"property1": null,
"property2": null
},
"errors": {"property1": null,
"property2": null
}
},
"latency_ms": [0
],
"instance_id": "string",
"container_id": "string"
}
}
},
"urls": {"destinations": {"property1": {"requests": {"host": "abc.cycle.io",
"method": "GET",
"path": "/pathname",
"total": 5,
"last_hit": "2021-01-30T08:30:00Z",
"handlers": {"proxy": null,
"cache": null,
"forward": null,
"redirect": null
},
"responses": {"http:404": 10
},
"errors": {"i/o timeout": 1
}
}
},
"property2": {"requests": {"host": "abc.cycle.io",
"method": "GET",
"path": "/pathname",
"total": 5,
"last_hit": "2021-01-30T08:30:00Z",
"handlers": {"proxy": null,
"cache": null,
"forward": null,
"redirect": null
},
"responses": {"http:404": 10
},
"errors": {"i/o timeout": 1
}
}
}
}
},
"metrics": {"disconnects": {"no_error": 0,
"request_invalid": 0,
"timeout_idle": 0,
"router_none": 0,
"router_nomatch": 0,
"destination_unavailable": 0,
"unknown_error": 0
},
"connections": 0,
"requests": 0,
"bytes_transmitted": 0,
"bytes_received": 0
}
}
},
"property2": {"time": "2021-01-30T08:30:00Z",
"started": "2021-01-30T08:30:00Z",
"version": "string",
"dataset_id": 0,
"current": {"router": {"destinations": {"property1": {"connections": {"success": 0,
"unavailable": 0,
"errors": {"property1": null,
"property2": null
},
"bytes_transmitted": 0,
"bytes_received": 0
},
"requests": {"total": 0,
"responses": {"property1": null,
"property2": null
},
"errors": {"property1": null,
"property2": null
}
},
"latency_ms": [0
],
"instance_id": "string",
"container_id": "string"
},
"property2": {"connections": {"success": 0,
"unavailable": 0,
"errors": {"property1": null,
"property2": null
},
"bytes_transmitted": 0,
"bytes_received": 0
},
"requests": {"total": 0,
"responses": {"property1": null,
"property2": null
},
"errors": {"property1": null,
"property2": null
}
},
"latency_ms": [0
],
"instance_id": "string",
"container_id": "string"
}
}
},
"urls": {"destinations": {"property1": {"requests": {"host": "abc.cycle.io",
"method": "GET",
"path": "/pathname",
"total": 5,
"last_hit": "2021-01-30T08:30:00Z",
"handlers": {"proxy": null,
"cache": null,
"forward": null,
"redirect": null
},
"responses": {"http:404": 10
},
"errors": {"i/o timeout": 1
}
}
},
"property2": {"requests": {"host": "abc.cycle.io",
"method": "GET",
"path": "/pathname",
"total": 5,
"last_hit": "2021-01-30T08:30:00Z",
"handlers": {"proxy": null,
"cache": null,
"forward": null,
"redirect": null
},
"responses": {"http:404": 10
},
"errors": {"i/o timeout": 1
}
}
}
}
},
"metrics": {"disconnects": {"no_error": 0,
"request_invalid": 0,
"timeout_idle": 0,
"router_none": 0,
"router_nomatch": 0,
"destination_unavailable": 0,
"unknown_error": 0
},
"connections": 0,
"requests": 0,
"bytes_transmitted": 0,
"bytes_received": 0
}
},
"cumulative": {"router": {"destinations": {"property1": {"connections": {"success": 0,
"unavailable": 0,
"errors": {"property1": null,
"property2": null
},
"bytes_transmitted": 0,
"bytes_received": 0
},
"requests": {"total": 0,
"responses": {"property1": null,
"property2": null
},
"errors": {"property1": null,
"property2": null
}
},
"latency_ms": [0
],
"instance_id": "string",
"container_id": "string"
},
"property2": {"connections": {"success": 0,
"unavailable": 0,
"errors": {"property1": null,
"property2": null
},
"bytes_transmitted": 0,
"bytes_received": 0
},
"requests": {"total": 0,
"responses": {"property1": null,
"property2": null
},
"errors": {"property1": null,
"property2": null
}
},
"latency_ms": [0
],
"instance_id": "string",
"container_id": "string"
}
}
},
"urls": {"destinations": {"property1": {"requests": {"host": "abc.cycle.io",
"method": "GET",
"path": "/pathname",
"total": 5,
"last_hit": "2021-01-30T08:30:00Z",
"handlers": {"proxy": null,
"cache": null,
"forward": null,
"redirect": null
},
"responses": {"http:404": 10
},
"errors": {"i/o timeout": 1
}
}
},
"property2": {"requests": {"host": "abc.cycle.io",
"method": "GET",
"path": "/pathname",
"total": 5,
"last_hit": "2021-01-30T08:30:00Z",
"handlers": {"proxy": null,
"cache": null,
"forward": null,
"redirect": null
},
"responses": {"http:404": 10
},
"errors": {"i/o timeout": 1
}
}
}
}
},
"metrics": {"disconnects": {"no_error": 0,
"request_invalid": 0,
"timeout_idle": 0,
"router_none": 0,
"router_nomatch": 0,
"destination_unavailable": 0,
"unknown_error": 0
},
"connections": 0,
"requests": 0,
"bytes_transmitted": 0,
"bytes_received": 0
}
}
}
}

Response samples

200
default

application/json

{"data": true
}

Get Environment Scoped Variables

Gets the scoped variables that are accessible to this instance via internal API.

SecuritytokenAuth

Responses

200

Returns a map of variable values, keyed by their identifier.

default

General error response from the platform

get/v1/environment/scoped-variables

Response samples

200
default

application/json

{"data": {"property1": "string",
"property2": "string"
}
}

Validate VPN Login

Validates a username/password pair for logging into the VPN service of the environment of this instance. You must pass a basic Authorization header with the desired username/password combination to validate.

SecuritytokenAuth or basicAuth

Responses

200

Returns true on success

403

Returns false on verification failure

default

General error response from the platform

post/v1/vpn/login

Response samples

200
403
default

application/json

{"data": true
}

List Network Environments

Lists all environments present in this instance's SDN networks.

SecuritytokenAuth

Responses

200

Returns a list of environments.

default

General error response from the platform

get/v1/sdn/networks/environments

Response samples

200
default

application/json

{"data": [{"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": [null
],
"controller_template": {"identifier": null,
"port": null,
"waf": null,
"transport": { }
},
"waf": {"rules": [ ]
}
},
"bind_host": true
}
},
"discovery": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"empty_set_delay": "72h45m2s",
"hosts": {"property1": {"ipv4": [ ],
"ipv6": [ ]
},
"property2": {"ipv4": [ ],
"ipv6": [ ]
}
},
"custom_resolvers": ["string"
]
}
},
"vpn": {"enable": true,
"container_id": "string",
"auto_update": true,
"config": {"allow_internet": true,
"auth": {"webhook": "string",
"cycle_accounts": true,
"vpn_accounts": true
}
}
},
"scheduler": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"public": true,
"access_keys": [{"name": null,
"secret": null,
"ips": [ ]
}
]
}
}
},
"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": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
},
"image": {"id": "651586fca6078e98982dbd90",
"service": "discovery"
},
"environment": {"id": "651586fca6078e98982dbd90",
"cluster": "string",
"container_subnet": "string",
"ipv6": {"ip": null,
"cidr": null
},
"legacy": {"subnet": null,
"ipv4": null
}
}
}
]
}
}
]
}

Containers

List Environment Containers

Lists all Containers that are part of the same Environment as this Instance.

SecuritytokenAuth

Responses

200

Returns a collection of container resources.

default

General error response from the platform

get/v1/environment/containers

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"environment": {"id": "651586fca6078e98982dbd90",
"cluster": "string",
"container_subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"hub_id": "651586fca6078e98982dbd90",
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "virtual-machine-v1",
"id": "651586fca6078e98982dbd90"
},
"service": "discovery"
},
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": ["string"
]
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": 0,
"max_shard_concurrency": 0,
"max_runtime": "72h45m2s",
"max_queue_time": "72h45m2s"
},
"stateful": {"options": {"use_base_hostname": true
}
},
"constraints": {"node": {"tags": {"any": [ ],
"all": [ ]
}
},
"secrets": ["string"
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": ["SIGTERM"
]
},
"startup": {"delay": "72h45m2s"
},
"update": {"stagger": "72h45m2s"
},
"restart": {"condition": "always",
"delay": "72h45m2s",
"max_attempts": 0
},
"health_check": {"command": "string",
"retries": 0,
"delay": "72h45m2s",
"interval": "72h45m2s",
"timeout": "72h45m2s",
"restart": true
},
"telemetry": {"retention": "72h45m2s",
"interval": "72h45m2s",
"disable": true
}
},
"scale": {"autoscale_group": "string",
"instances": {"max": 0,
"max_server": 0,
"min_ttl": "72h45m2s"
},
"window": "72h45m2s",
"thresholds": [{"type": "ram",
"details": {"usage": null
}
}
]
},
"runtime": {"command": {"path": "string",
"args": "string"
},
"namespaces": ["ipc"
],
"environment_vars": {"property1": "string",
"property2": "string"
},
"privileged": true,
"capabilities": ["CAP_CHOWN"
],
"workdir": "string",
"sysctl": {"property1": "string",
"property2": "string"
},
"rlimits": {"property1": {"hard": 0,
"soft": 0
},
"property2": {"hard": 0,
"soft": 0
}
},
"seccomp": {"disable": true,
"rules": [{"capabilities": { },
"syscall": { }
}
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M"
}
},
"resources": {"cpu": {"shares": {"limit": 0,
"reserve": 0
},
"cpus": "string"
},
"ram": {"limit": "1G",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": "string",
"start": "string",
"stop": "string"
},
"config": "string"
},
"files": [{"source": "string",
"destination": "string"
}
],
"lets_encrypt": {"enable": true,
"certificate_path": "string",
"chain_path": "string",
"key_path": "string",
"bundle_path": "string",
"additional_certs_path": "string"
},
"backups": {"integration_id": "my-image-source",
"backup": {"command": "string",
"timeout": "72h45m2s",
"cron_string": "string"
},
"restore": {"command": "string",
"timeout": "72h45m2s"
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": true,
"mount_point": "string"
},
"property2": {"writable": true,
"mount_point": "string"
}
},
"logs": {"groups": ["string"
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"config": {"read_only": true,
"block_device": true,
"local": {"max_size": "10G",
"storage_pool": true
},
"destination": "string",
"remote_access": {"enable": true,
"ips": [null
],
"webhook": "string",
"password": {"algorithm": null,
"data": null
}
}
}
}
],
"annotations": {"property1": null,
"property2": null
},
"role": "orchestrator",
"stateful": true,
"deprecate": true,
"lock": true,
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"started": "2021-01-30T08:30:00Z"
},
"meta": {"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"domains": [{"fqdn": "string",
"record": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": null,
"type": null
},
"zone_id": "string",
"name": "string",
"resolved_domain": "string",
"type": {"a": { },
"aaaa": { },
"cname": { },
"ns": { },
"mx": { },
"txt": { },
"alias": { },
"srv": { },
"caa": { },
"linked": { }
},
"features": {"certificate": null
},
"state": {"changed": null,
"error": { }
},
"events": {"property1": null,
"property2": null
}
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": "651586fca6078e98982dbd90",
"instance_id": "651586fca6078e98982dbd90",
"environment_id": "651586fca6078e98982dbd90",
"virtual_machine": {"id": null
}
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
}
}
]
}
}
]
}

List Server Containers

Lists all containers present on the same server as this instance.

SecuritytokenAuth

Responses

200

Returns a list of containers.

default

General error response from the platform

get/v1/server/containers

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"environment": {"id": "651586fca6078e98982dbd90",
"cluster": "string",
"container_subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"hub_id": "651586fca6078e98982dbd90",
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "virtual-machine-v1",
"id": "651586fca6078e98982dbd90"
},
"service": "discovery"
},
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": ["string"
]
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": 0,
"max_shard_concurrency": 0,
"max_runtime": "72h45m2s",
"max_queue_time": "72h45m2s"
},
"stateful": {"options": {"use_base_hostname": true
}
},
"constraints": {"node": {"tags": {"any": [ ],
"all": [ ]
}
},
"secrets": ["string"
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": ["SIGTERM"
]
},
"startup": {"delay": "72h45m2s"
},
"update": {"stagger": "72h45m2s"
},
"restart": {"condition": "always",
"delay": "72h45m2s",
"max_attempts": 0
},
"health_check": {"command": "string",
"retries": 0,
"delay": "72h45m2s",
"interval": "72h45m2s",
"timeout": "72h45m2s",
"restart": true
},
"telemetry": {"retention": "72h45m2s",
"interval": "72h45m2s",
"disable": true
}
},
"scale": {"autoscale_group": "string",
"instances": {"max": 0,
"max_server": 0,
"min_ttl": "72h45m2s"
},
"window": "72h45m2s",
"thresholds": [{"type": "ram",
"details": {"usage": null
}
}
]
},
"runtime": {"command": {"path": "string",
"args": "string"
},
"namespaces": ["ipc"
],
"environment_vars": {"property1": "string",
"property2": "string"
},
"privileged": true,
"capabilities": ["CAP_CHOWN"
],
"workdir": "string",
"sysctl": {"property1": "string",
"property2": "string"
},
"rlimits": {"property1": {"hard": 0,
"soft": 0
},
"property2": {"hard": 0,
"soft": 0
}
},
"seccomp": {"disable": true,
"rules": [{"capabilities": { },
"syscall": { }
}
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M"
}
},
"resources": {"cpu": {"shares": {"limit": 0,
"reserve": 0
},
"cpus": "string"
},
"ram": {"limit": "1G",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": "string",
"start": "string",
"stop": "string"
},
"config": "string"
},
"files": [{"source": "string",
"destination": "string"
}
],
"lets_encrypt": {"enable": true,
"certificate_path": "string",
"chain_path": "string",
"key_path": "string",
"bundle_path": "string",
"additional_certs_path": "string"
},
"backups": {"integration_id": "my-image-source",
"backup": {"command": "string",
"timeout": "72h45m2s",
"cron_string": "string"
},
"restore": {"command": "string",
"timeout": "72h45m2s"
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": true,
"mount_point": "string"
},
"property2": {"writable": true,
"mount_point": "string"
}
},
"logs": {"groups": ["string"
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"config": {"read_only": true,
"block_device": true,
"local": {"max_size": "10G",
"storage_pool": true
},
"destination": "string",
"remote_access": {"enable": true,
"ips": [null
],
"webhook": "string",
"password": {"algorithm": null,
"data": null
}
}
}
}
],
"annotations": {"property1": null,
"property2": null
},
"role": "orchestrator",
"stateful": true,
"deprecate": true,
"lock": true,
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"started": "2021-01-30T08:30:00Z"
},
"meta": {"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"domains": [{"fqdn": "string",
"record": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": null,
"type": null
},
"zone_id": "string",
"name": "string",
"resolved_domain": "string",
"type": {"a": { },
"aaaa": { },
"cname": { },
"ns": { },
"mx": { },
"txt": { },
"alias": { },
"srv": { },
"caa": { },
"linked": { }
},
"features": {"certificate": null
},
"state": {"changed": null,
"error": { }
},
"events": {"property1": null,
"property2": null
}
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": "651586fca6078e98982dbd90",
"instance_id": "651586fca6078e98982dbd90",
"environment_id": "651586fca6078e98982dbd90",
"virtual_machine": {"id": null
}
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
}
}
]
}
}
]
}

List Server Images

Lists all images downloaded onto the server this instance is on.

SecuritytokenAuth

Responses

200

Returns a list of image details (id, time accessed).

default

General error response from the platform

get/v1/server/images

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"access_time": "2021-01-30T08:30:00Z"
}
]
}

Get Container

Gets a container. By default will grab the container of this instance, but a `container-id`` parameter can be passed to grab any other container in the same environment.

SecuritytokenAuth

Request

query Parameters

container-id

string

Specify which container to fetch. If not provided, will use the container of the current instance.

Responses

200

Returns a container.

default

General error response from the platform

get/v1/container

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"environment": {"id": "651586fca6078e98982dbd90",
"cluster": "string",
"container_subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"hub_id": "651586fca6078e98982dbd90",
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "virtual-machine-v1",
"id": "651586fca6078e98982dbd90"
},
"service": "discovery"
},
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": ["string"
]
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": 0,
"max_shard_concurrency": 0,
"max_runtime": "72h45m2s",
"max_queue_time": "72h45m2s"
},
"stateful": {"options": {"use_base_hostname": true
}
},
"constraints": {"node": {"tags": {"any": [null
],
"all": [null
]
}
},
"secrets": ["string"
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": ["SIGTERM"
]
},
"startup": {"delay": "72h45m2s"
},
"update": {"stagger": "72h45m2s"
},
"restart": {"condition": "always",
"delay": "72h45m2s",
"max_attempts": 0
},
"health_check": {"command": "string",
"retries": 0,
"delay": "72h45m2s",
"interval": "72h45m2s",
"timeout": "72h45m2s",
"restart": true
},
"telemetry": {"retention": "72h45m2s",
"interval": "72h45m2s",
"disable": true
}
},
"scale": {"autoscale_group": "string",
"instances": {"max": 0,
"max_server": 0,
"min_ttl": "72h45m2s"
},
"window": "72h45m2s",
"thresholds": [{"type": "ram",
"details": {"usage": "2G"
}
}
]
},
"runtime": {"command": {"path": "string",
"args": "string"
},
"namespaces": ["ipc"
],
"environment_vars": {"property1": "string",
"property2": "string"
},
"privileged": true,
"capabilities": ["CAP_CHOWN"
],
"workdir": "string",
"sysctl": {"property1": "string",
"property2": "string"
},
"rlimits": {"property1": {"hard": 0,
"soft": 0
},
"property2": {"hard": 0,
"soft": 0
}
},
"seccomp": {"disable": true,
"rules": [{"capabilities": {"includes": null,
"excludes": null
},
"syscall": {"names": [ ],
"action": null,
"errnoRet": null,
"args": [ ]
}
}
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M"
}
},
"resources": {"cpu": {"shares": {"limit": 0,
"reserve": 0
},
"cpus": "string"
},
"ram": {"limit": "1G",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": "string",
"start": "string",
"stop": "string"
},
"config": "string"
},
"files": [{"source": "string",
"destination": "string"
}
],
"lets_encrypt": {"enable": true,
"certificate_path": "string",
"chain_path": "string",
"key_path": "string",
"bundle_path": "string",
"additional_certs_path": "string"
},
"backups": {"integration_id": "my-image-source",
"backup": {"command": "string",
"timeout": "72h45m2s",
"cron_string": "string"
},
"restore": {"command": "string",
"timeout": "72h45m2s"
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": true,
"mount_point": "string"
},
"property2": {"writable": true,
"mount_point": "string"
}
},
"logs": {"groups": ["string"
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"config": {"read_only": true,
"block_device": true,
"local": {"max_size": "10G",
"storage_pool": true
},
"destination": "string",
"remote_access": {"enable": true,
"ips": ["string"
],
"webhook": "string",
"password": {"algorithm": "raw",
"data": "string"
}
}
}
}
],
"annotations": {"property1": null,
"property2": null
},
"role": "orchestrator",
"stateful": true,
"deprecate": true,
"lock": true,
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"started": "2021-01-30T08:30:00Z"
},
"meta": {"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"domains": [{"fqdn": "string",
"record": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"zone_id": "string",
"name": "string",
"resolved_domain": "string",
"type": {"a": {"ip": null
},
"aaaa": {"ip": null
},
"cname": {"domain": null
},
"ns": {"domain": null
},
"mx": {"priority": null,
"domain": null
},
"txt": {"value": null
},
"alias": {"domain": null
},
"srv": {"weight": null,
"priority": null,
"port": null,
"domain": null
},
"caa": {"tag": null,
"value": null
},
"linked": {"features": { },
"container_id": null
}
},
"features": {"certificate": {"id": null,
"generated": null,
"wildcard_child": null
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
},
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
}
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": "651586fca6078e98982dbd90",
"instance_id": "651586fca6078e98982dbd90",
"environment_id": "651586fca6078e98982dbd90",
"virtual_machine": {"id": "651586fca6078e98982dbd90"
}
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
]
}
}
}

Get Container Instances

Gets the instances of a container. By default will grab the instances of the same container, but a `container-id`` parameter can be passed to grab any other container instances in the same environment.

SecuritytokenAuth

Request

query Parameters

container-id

string

Specify which container to fetch instances of. If not provided, will use the container of the current instance.

Responses

200

Returns a list of instances.

default

General error response from the platform

get/v1/container/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"
}
}
]
}

List Container Certificates

Get the TLS certificates associated with the domains pointed at this container.

SecuritytokenAuth

Request

query Parameters

container-id

string

Specify which container to get certificates for. If not provided, will use the container of the current instance.

Responses

200

Returns a list of TLS certificates.

default

General error response from the platform

get/v1/containers/certificates

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"domains": ["string"
],
"private_key": "string",
"bundle": "string",
"csr": "string",
"issuer_certificate": "string",
"hub_id": "651586fca6078e98982dbd90"
}
]
}

List Container Domains

Get the domains pointed at a container.

SecuritytokenAuth

Request

query Parameters

container-id

string

Specify which container to get domains for. If not provided, will use the container of the current instance.

Responses

200

Returns a list of domains.

default

General error response from the platform

get/v1/containers/domains

Response samples

200
default

application/json

{"data": [{"fqdn": "string",
"record": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"zone_id": "string",
"name": "string",
"resolved_domain": "string",
"type": {"a": {"ip": "string"
},
"aaaa": {"ip": "string"
},
"cname": {"domain": "string"
},
"ns": {"domain": "string"
},
"mx": {"priority": 0,
"domain": "string"
},
"txt": {"value": "string"
},
"alias": {"domain": "string"
},
"srv": {"weight": 0,
"priority": 0,
"port": 0,
"domain": "string"
},
"caa": {"tag": "string",
"value": "string"
},
"linked": {"features": {"tls": {"enable": null
},
"geodns": {"enable": null
},
"wildcard": {"resolve_sub_domains": null
}
},
"container_id": "string"
}
},
"features": {"certificate": {"id": "651586fca6078e98982dbd90",
"generated": "2021-01-30T08:30:00Z",
"wildcard_child": true
}
},
"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"
}
}
}
]
}

Create Instance Job

Used to perform different actions on a given instance.

SecuritytokenAuth

Request

Request Body schema: application/json
required

action required	string container.instance.start
required	object

Responses

200

Returns nothing on success.

default

General error response from the platform

post/v1/conductor/tasks

Request samples

Payload

application/json

{"action": "container.instance.start",
"contents": {"instance_id": "651586fca6078e98982dbd90",
"container_id": "651586fca6078e98982dbd90",
"function": {"token": "string",
"runtime_variables": {"environment_variables": {"property1": "string",
"property2": "string"
}
}
}
}
}

Response samples

200
default

application/json

{ }

Instances

List Environment Instances

Lists all Instances present in this Instance's Environment.

SecuritytokenAuth

Responses

200

Returns a list of Instances.

default

General error response from the platform

get/v1/environment/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"
}
}
]
}

Get Server Instances

Gets a list of instances that are on the same server as this instance.

SecuritytokenAuth

Responses

200

Returns a list of instances.

default

General error response from the platform

get/v1/server/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"
}
}
]
}

Get Server Instances Telemetry

Gets resource telemetry for this instance.

SecuritytokenAuth

Responses

200

Returns a list of resource telemetry snapshots.

default

General error response from the platform

get/v1/server/instances/telemetry

Response samples

200
default

application/json

{"data": [{"instance_id": "651586fca6078e98982dbd90",
"container_id": "651586fca6078e98982dbd90",
"environment_id": "651586fca6078e98982dbd90",
"stats": {"time": "2021-01-30T08:30:00Z",
"hub_id": "651586fca6078e98982dbd90",
"container_id": "651586fca6078e98982dbd90",
"instance_id": "651586fca6078e98982dbd90",
"environment_id": "651586fca6078e98982dbd90",
"server_id": "651586fca6078e98982dbd90",
"cluster": "string",
"cpu": {"num_cores": 0,
"usage": {"total": 0,
"kernel": 0,
"user": 0
},
"throttling": {"periods": 0,
"throttled_periods": 0,
"throttled_time": 0
}
},
"memory": {"cache": 0,
"usage": {"usage": 0,
"max_usage": 0,
"fail_count": 0,
"limit": 0
},
"swap_usage": {"usage": 0,
"max_usage": 0,
"fail_count": 0,
"limit": 0
},
"kernel_usage": {"usage": 0,
"max_usage": 0,
"fail_count": 0,
"limit": 0
},
"kernel_tcp_usage": {"usage": 0,
"max_usage": 0,
"fail_count": 0,
"limit": 0
}
},
"processes": {"current": 0,
"limit": 0
},
"network": {"interfaces": [{"name": "string",
"rx_bytes": 0,
"tx_bytes": 0
}
]
},
"hugetlb": {"usage": 0,
"max": 0,
"fail_count": 0
}
}
}
]
}

Get Container Instances

SecuritytokenAuth

Request

query Parameters

container-id

string

Specify which container to fetch instances of. If not provided, will use the container of the current instance.

Responses

200

Returns a list of instances.

default

General error response from the platform

get/v1/container/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"
}
}
]
}

Create Instance Job

Used to perform different actions on a given instance.

SecuritytokenAuth

Request

Request Body schema: application/json
required

action required	string container.instance.start
required	object

Responses

200

Returns nothing on success.

default

General error response from the platform

post/v1/conductor/tasks

Request samples

Payload

application/json

{"action": "container.instance.start",
"contents": {"instance_id": "651586fca6078e98982dbd90",
"container_id": "651586fca6078e98982dbd90",
"function": {"token": "string",
"runtime_variables": {"environment_variables": {"property1": "string",
"property2": "string"
}
}
}
}
}

Response samples

200
default

application/json

{ }

List Network Instances

Lists all instances present in this instance's SDN networks.

SecuritytokenAuth

Responses

200

Returns a list of instances.

default

General error response from the platform

get/v1/sdn/networks/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"
}
}
]
}

Scoped Variables

Get Environment Scoped Variables

Gets the scoped variables that are accessible to this instance via internal API.

SecuritytokenAuth

Responses

200

Returns a map of variable values, keyed by their identifier.

default

General error response from the platform

get/v1/environment/scoped-variables

Response samples

200
default

application/json

{"data": {"property1": "string",
"property2": "string"
}
}

Hubs

Get Hub

Gets the hub that this instance is a member of.

SecuritytokenAuth

Responses

200

Returns a hub.

default

General error response from the platform

get/v1/hub

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"name": "string",
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"converted": "2021-01-30T08:30:00Z",
"first_order": "2021-01-30T08:30:00Z",
"first_provider": "2021-01-30T08:30:00Z",
"first_server": "2021-01-30T08:30:00Z",
"first_environment": "2021-01-30T08:30:00Z",
"first_image": "2021-01-30T08:30:00Z",
"first_container": "2021-01-30T08:30:00Z"
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"meta": {"membership": {"id": "651586fca6078e98982dbd90",
"account_id": "string",
"hub_id": "651586fca6078e98982dbd90",
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"joined": "2021-01-30T08:30:00Z"
},
"role_id": "651586fca6078e98982dbd90",
"preferences": {"portal": {"notifications": {"jobs": {"apikey_alerts": null
}
}
},
"email": {"notificaitons": {"server": {"new": null,
"offline": null
}
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"invitation": {"sender": {"id": "651586fca6078e98982dbd90",
"type": "string"
},
"recipient": "string",
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"accepted": "2021-01-30T08:30:00Z",
"declined": "2021-01-30T08:30:00Z",
"revoked": "2021-01-30T08:30:00Z"
}
},
"cycle": {"employee_id": "string"
}
}
}
}
}

Get Hub Integration

Gets an integration based on a provided identifier or vendor query parameter. At least one of these must be provided.

SecuritytokenAuth

Request

query Parameters

identifier	string An integration identifier.
vendor	string An integration vendor.

Responses

200

Returns a hub integration.

default

General error response from the platform

get/v1/hub/integrations

Response samples

200
default

application/json

{"data": {"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": [{"title": "string",
"key": "string",
"type": "string"
}
]
},
"fields": {"extra": {"property1": {"regex": "string",
"required": true,
"description": "string"
},
"property2": {"regex": "string",
"required": true,
"description": "string"
}
},
"auth": {"property1": {"regex": "string",
"required": true,
"description": "string"
},
"property2": {"regex": "string",
"required": true,
"description": "string"
}
}
},
"url": "http://example.com",
"public": true,
"usable": true,
"editable": true
}
}
}
}

Servers

Get Server

Gets the server this instance is running on.

SecuritytokenAuth

Responses

200

Returns a server.

default

General error response from the platform

get/v1/server

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

Get Server Instances

Gets a list of instances that are on the same server as this instance.

SecuritytokenAuth

Responses

200

Returns a list of instances.

default

General error response from the platform

get/v1/server/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"
}
}
]
}

Get Server Instances Telemetry

Gets resource telemetry for this instance.

SecuritytokenAuth

Responses

200

Returns a list of resource telemetry snapshots.

default

General error response from the platform

get/v1/server/instances/telemetry

Response samples

200
default

application/json

{"data": [{"instance_id": "651586fca6078e98982dbd90",
"container_id": "651586fca6078e98982dbd90",
"environment_id": "651586fca6078e98982dbd90",
"stats": {"time": "2021-01-30T08:30:00Z",
"hub_id": "651586fca6078e98982dbd90",
"container_id": "651586fca6078e98982dbd90",
"instance_id": "651586fca6078e98982dbd90",
"environment_id": "651586fca6078e98982dbd90",
"server_id": "651586fca6078e98982dbd90",
"cluster": "string",
"cpu": {"num_cores": 0,
"usage": {"total": 0,
"kernel": 0,
"user": 0
},
"throttling": {"periods": 0,
"throttled_periods": 0,
"throttled_time": 0
}
},
"memory": {"cache": 0,
"usage": {"usage": 0,
"max_usage": 0,
"fail_count": 0,
"limit": 0
},
"swap_usage": {"usage": 0,
"max_usage": 0,
"fail_count": 0,
"limit": 0
},
"kernel_usage": {"usage": 0,
"max_usage": 0,
"fail_count": 0,
"limit": 0
},
"kernel_tcp_usage": {"usage": 0,
"max_usage": 0,
"fail_count": 0,
"limit": 0
}
},
"processes": {"current": 0,
"limit": 0
},
"network": {"interfaces": [{"name": "string",
"rx_bytes": 0,
"tx_bytes": 0
}
]
},
"hugetlb": {"usage": 0,
"max": 0,
"fail_count": 0
}
}
}
]
}

List Server Containers

Lists all containers present on the same server as this instance.

SecuritytokenAuth

Responses

200

Returns a list of containers.

default

General error response from the platform

get/v1/server/containers

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"environment": {"id": "651586fca6078e98982dbd90",
"cluster": "string",
"container_subnet": "string",
"ipv6": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
},
"legacy": {"subnet": 0,
"ipv4": {"ip": "fd00::21:0:0:0",
"cidr": "fd00::21:0:0:0/96"
}
}
},
"hub_id": "651586fca6078e98982dbd90",
"image": {"id": "651586fca6078e98982dbd90",
"extension": {"identifier": "virtual-machine-v1",
"id": "651586fca6078e98982dbd90"
},
"service": "discovery"
},
"stack": {"id": "651586fca6078e98982dbd90",
"build_id": "string",
"identifier": "string"
},
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": ["string"
]
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": 0,
"max_shard_concurrency": 0,
"max_runtime": "72h45m2s",
"max_queue_time": "72h45m2s"
},
"stateful": {"options": {"use_base_hostname": true
}
},
"constraints": {"node": {"tags": {"any": [ ],
"all": [ ]
}
},
"secrets": ["string"
]
},
"shutdown": {"graceful_timeout": "72h45m2s",
"signals": ["SIGTERM"
]
},
"startup": {"delay": "72h45m2s"
},
"update": {"stagger": "72h45m2s"
},
"restart": {"condition": "always",
"delay": "72h45m2s",
"max_attempts": 0
},
"health_check": {"command": "string",
"retries": 0,
"delay": "72h45m2s",
"interval": "72h45m2s",
"timeout": "72h45m2s",
"restart": true
},
"telemetry": {"retention": "72h45m2s",
"interval": "72h45m2s",
"disable": true
}
},
"scale": {"autoscale_group": "string",
"instances": {"max": 0,
"max_server": 0,
"min_ttl": "72h45m2s"
},
"window": "72h45m2s",
"thresholds": [{"type": "ram",
"details": {"usage": null
}
}
]
},
"runtime": {"command": {"path": "string",
"args": "string"
},
"namespaces": ["ipc"
],
"environment_vars": {"property1": "string",
"property2": "string"
},
"privileged": true,
"capabilities": ["CAP_CHOWN"
],
"workdir": "string",
"sysctl": {"property1": "string",
"property2": "string"
},
"rlimits": {"property1": {"hard": 0,
"soft": 0
},
"property2": {"hard": 0,
"soft": 0
}
},
"seccomp": {"disable": true,
"rules": [{"capabilities": { },
"syscall": { }
}
]
},
"host": {"expose_proc": true
},
"rootfs": {"readonly": true
},
"devices": {"shm_size": "64M"
}
},
"resources": {"cpu": {"shares": {"limit": 0,
"reserve": 0
},
"cpus": "string"
},
"ram": {"limit": "1G",
"reserve": "string"
}
},
"integrations": {"webhooks": {"events": {"deploy": "string",
"start": "string",
"stop": "string"
},
"config": "string"
},
"files": [{"source": "string",
"destination": "string"
}
],
"lets_encrypt": {"enable": true,
"certificate_path": "string",
"chain_path": "string",
"key_path": "string",
"bundle_path": "string",
"additional_certs_path": "string"
},
"backups": {"integration_id": "my-image-source",
"backup": {"command": "string",
"timeout": "72h45m2s",
"cron_string": "string"
},
"restore": {"command": "string",
"timeout": "72h45m2s"
},
"retention": "365d"
},
"shared_file_systems": {"property1": {"writable": true,
"mount_point": "string"
},
"property2": {"writable": true,
"mount_point": "string"
}
},
"logs": {"groups": ["string"
]
}
}
},
"deployment": {"version": "v1.2.3-dev"
},
"instances": 0,
"volumes": [{"id": "651586fca6078e98982dbd90",
"hash": "string",
"config": {"read_only": true,
"block_device": true,
"local": {"max_size": "10G",
"storage_pool": true
},
"destination": "string",
"remote_access": {"enable": true,
"ips": [null
],
"webhook": "string",
"password": {"algorithm": null,
"data": null
}
}
}
}
],
"annotations": {"property1": null,
"property2": null
},
"role": "orchestrator",
"stateful": true,
"deprecate": true,
"lock": true,
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"started": "2021-01-30T08:30:00Z"
},
"meta": {"instances_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"domains": [{"fqdn": "string",
"record": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": null,
"type": null
},
"zone_id": "string",
"name": "string",
"resolved_domain": "string",
"type": {"a": { },
"aaaa": { },
"cname": { },
"ns": { },
"mx": { },
"txt": { },
"alias": { },
"srv": { },
"caa": { },
"linked": { }
},
"features": {"certificate": null
},
"state": {"changed": null,
"error": { }
},
"events": {"property1": null,
"property2": null
}
}
}
],
"ips": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"kind": "ipv4",
"assignment": {"container_id": "651586fca6078e98982dbd90",
"instance_id": "651586fca6078e98982dbd90",
"environment_id": "651586fca6078e98982dbd90",
"virtual_machine": {"id": null
}
},
"pool_id": "string",
"address": "string",
"gateway": "string",
"cidr": "string",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
}
}
]
}
}
]
}

List Server Images

Lists all images downloaded onto the server this instance is on.

SecuritytokenAuth

Responses

200

Returns a list of image details (id, time accessed).

default

General error response from the platform

get/v1/server/images

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"access_time": "2021-01-30T08:30:00Z"
}
]
}

Download Image

Downloads the specified image to the server.

SecuritytokenAuth

Request

Request Body schema: application/json
required

image_id

required

string <objectid> (ID)

A 24 character hex string used to identify a unique resource.

Responses

200

Returns the details of the downloaded image.

default

General error response from the platform

post/v1/server/images/download

Request samples

Payload

application/json

{"image_id": "651586fca6078e98982dbd90"
}

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"access_time": "2021-01-30T08:30:00Z"
}
]
}

Images

Download Image

Downloads the specified image to the server.

SecuritytokenAuth

Request

Request Body schema: application/json
required

image_id

required

string <objectid> (ID)

A 24 character hex string used to identify a unique resource.

Responses

200

Returns the details of the downloaded image.

default

General error response from the platform

post/v1/server/images/download

Request samples

Payload

application/json

{"image_id": "651586fca6078e98982dbd90"
}

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"access_time": "2021-01-30T08:30:00Z"
}
]
}

Monitoring

Post Metric

Post data to Cycle's monitoring system.

SecuritytokenAuth

Request

Request Body schema: application/json
required

Array

metric required	string The title of the metric this data point refers to.
type required	string The type of metric Enum: "gauge" "count" "counter" "rate" "histogram" "distribution" "set"
	object Any associated labels for the data, which can be used in querying.
tags	Array of strings Additional tags for the data point.
	Array of objects

Responses

200

Returns true on success

default

General error response from the platform

post/v1/monitoring/metrics

Request samples

Payload

application/json

[{"metric": "string",
"type": "gauge",
"labels": {"property1": "string",
"property2": "string"
},
"tags": ["string"
],
"points": [{"time": "2021-01-30T08:30:00Z",
"values": [0
]
}
]
}
]

Response samples

200
default

application/json

{"data": true
}

VPN

Validate VPN Login

SecuritytokenAuth or basicAuth

Responses

200

Returns true on success

403

Returns false on verification failure

default

General error response from the platform

post/v1/vpn/login

Response samples

200
403
default

application/json

{"data": true
}

SDN

List Networks

Lists all networks attached to this instance.

SecuritytokenAuth

Responses

200

Returns a list of networks.

default

General error response from the platform

get/v1/sdn/networks

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"name": "string",
"identifier": "string",
"cluster": "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"
}
},
"private_network": {"vxlan_tag": 0,
"subnet": "string",
"mac_addr_suffix": 0,
"ipv6": {"ip": "string",
"cidr": "string"
}
},
"environments": [{"id": "651586fca6078e98982dbd90",
"added": "2021-01-30T08:30:00Z"
}
],
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
}
]
}

List Network Instances

Lists all instances present in this instance's SDN networks.

SecuritytokenAuth

Responses

200

Returns a list of instances.

default

General error response from the platform

get/v1/sdn/networks/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"
}
}
]
}

List Network Environments

Lists all environments present in this instance's SDN networks.

SecuritytokenAuth

Responses

200

Returns a list of environments.

default

General error response from the platform

get/v1/sdn/networks/environments

Response samples

200
default

application/json

{"data": [{"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": [null
],
"controller_template": {"identifier": null,
"port": null,
"waf": null,
"transport": { }
},
"waf": {"rules": [ ]
}
},
"bind_host": true
}
},
"discovery": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"empty_set_delay": "72h45m2s",
"hosts": {"property1": {"ipv4": [ ],
"ipv6": [ ]
},
"property2": {"ipv4": [ ],
"ipv6": [ ]
}
},
"custom_resolvers": ["string"
]
}
},
"vpn": {"enable": true,
"container_id": "string",
"auto_update": true,
"config": {"allow_internet": true,
"auth": {"webhook": "string",
"cycle_accounts": true,
"vpn_accounts": true
}
}
},
"scheduler": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"public": true,
"access_keys": [{"name": null,
"secret": null,
"ips": [ ]
}
]
}
}
},
"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": "2021-01-30T08:30:00Z",
"error": {"message": null,
"time": null
}
},
"image": {"id": "651586fca6078e98982dbd90",
"service": "discovery"
},
"environment": {"id": "651586fca6078e98982dbd90",
"cluster": "string",
"container_subnet": "string",
"ipv6": {"ip": null,
"cidr": null
},
"legacy": {"subnet": null,
"ipv4": null
}
}
}
]
}
}
]
}

Cycle Internal API (1.0.0)

Environments

Get Environment

List Environment Containers

List Environment Instances

List Environment IPs

List Environment Services

Submit Environment Load Balancer Telemetry

Request Body schema: application/jsonrequired

Get Environment Scoped Variables

Validate VPN Login

List Network Environments

Containers

List Environment Containers

List Server Containers

List Server Images

Get Container

query Parameters

Get Container Instances

query Parameters

List Container Certificates

query Parameters

List Container Domains

query Parameters

Create Instance Job

Request Body schema: application/jsonrequired

Instances

List Environment Instances

Get Server Instances

Get Server Instances Telemetry

Get Container Instances

query Parameters

Create Instance Job

Request Body schema: application/jsonrequired

List Network Instances

Scoped Variables

Get Environment Scoped Variables

Hubs

Get Hub

Get Hub Integration

query Parameters

Servers

Get Server

Get Server Instances

Get Server Instances Telemetry

List Server Containers

List Server Images

Download Image

Request Body schema: application/jsonrequired

Images

Download Image

Request Body schema: application/jsonrequired

Monitoring

Post Metric

Request Body schema: application/jsonrequired

VPN

Validate VPN Login

SDN

List Networks

List Network Instances

List Network Environments

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required