Stack Builds

Endpoints for managing builds of a Cycle stack, including deploying a stack build to an environment.

Look Up Stack Build

Look up a Stack Build using only the Build ID, instead of requiring a Stack ID as well.

Requires the stacks-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

buildId

required

string

The ID of the Build.

Responses

200

Returns a Stack Build.

default

General error response from the platform

get/v1/stacks/builds/{buildId}

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"stack_id": "string",
"spec": {"version": "1.0",
"about": {"version": "string",
"description": "string"
},
"scoped_variables": [{"identifier": "string",
"scope": {"containers": {"global": true,
"ids": [null
],
"identifiers": [null
]
}
},
"access": {"env_variable": {"key": "string"
},
"internal_api": {"duration": "72h45m2s"
},
"file": {"decode": true,
"path": "/var/run/cycle/variables/<myVariable>"
}
},
"source": {"type": "url",
"details": {"url": "string",
"headers": {"property1": null,
"property2": null
},
"auth_token_url": "string"
}
}
}
],
"containers": {"property1": {"name": "string",
"image": {"name": "string",
"origin": {"type": "docker-hub",
"details": {"existing": null,
"target": null,
"username": null,
"token": null
}
},
"build": {"args": {"property1": null,
"property2": null
}
},
"builder": {"integration_id": "my-image-source"
}
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": "80:80"
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": null,
"max_shard_concurrency": null,
"max_runtime": null,
"max_queue_time": null
},
"stateful": {"options": { }
},
"constraints": {"node": { }
},
"shutdown": {"graceful_timeout": null,
"signals": null
},
"startup": {"delay": null
},
"update": {"stagger": null
},
"restart": {"condition": null,
"delay": null,
"max_attempts": null
},
"health_check": {"command": null,
"retries": null,
"interval": null,
"timeout": null,
"restart": null,
"delay": null
},
"telemetry": {"retention": null,
"interval": null,
"webhook": null,
"disable": null
}
},
"scaling": {"autoscale_group": "string",
"instances": {"max": null,
"max_server": null,
"min_ttl": null
},
"window": "72h45m2s",
"thresholds": [null
]
},
"runtime": {"workdir": "string",
"command": {"path": null,
"args": null
},
"environment_vars": {"property1": null,
"property2": null
},
"namespaces": [null
],
"sysctl": {"property1": null,
"property2": null
},
"rlimits": {"property1": { },
"property2": { }
},
"seccomp": {"disable": null,
"rules": null
},
"host": {"expose_proc": null
},
"privileged": true,
"capabilities": [null
],
"rootfs": {"readonly": null
}
},
"resources": {"cpu": {"shares": null,
"cpus": null
},
"ram": {"limit": null,
"reserve": null,
"swappiness": null
}
},
"integrations": {"webhooks": {"events": null,
"config": null
},
"lets_encrypt": {"certificate_path": null,
"chain_path": null,
"key_path": null,
"bundle_path": null,
"additional_certs_path": null
},
"files": [{ }
],
"backups": {"integration_id": null,
"backup": null,
"restore": null,
"retention": null
},
"shared_file_systems": {"property1": null,
"property2": null
},
"logs": {"drain": null
}
}
},
"role": "conductor",
"volumes": [{"local": {"max_size": null,
"storage_pool": null
},
"destination": "string",
"read_only": true,
"block_device": true,
"remote_access": {"enable": null,
"ips": null,
"webhook": null,
"password": null
}
}
],
"deprecate": true,
"lock": true
},
"property2": {"name": "string",
"image": {"name": "string",
"origin": {"type": "docker-hub",
"details": {"existing": null,
"target": null,
"username": null,
"token": null
}
},
"build": {"args": {"property1": null,
"property2": null
}
},
"builder": {"integration_id": "my-image-source"
}
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": "80:80"
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": null,
"max_shard_concurrency": null,
"max_runtime": null,
"max_queue_time": null
},
"stateful": {"options": { }
},
"constraints": {"node": { }
},
"shutdown": {"graceful_timeout": null,
"signals": null
},
"startup": {"delay": null
},
"update": {"stagger": null
},
"restart": {"condition": null,
"delay": null,
"max_attempts": null
},
"health_check": {"command": null,
"retries": null,
"interval": null,
"timeout": null,
"restart": null,
"delay": null
},
"telemetry": {"retention": null,
"interval": null,
"webhook": null,
"disable": null
}
},
"scaling": {"autoscale_group": "string",
"instances": {"max": null,
"max_server": null,
"min_ttl": null
},
"window": "72h45m2s",
"thresholds": [null
]
},
"runtime": {"workdir": "string",
"command": {"path": null,
"args": null
},
"environment_vars": {"property1": null,
"property2": null
},
"namespaces": [null
],
"sysctl": {"property1": null,
"property2": null
},
"rlimits": {"property1": { },
"property2": { }
},
"seccomp": {"disable": null,
"rules": null
},
"host": {"expose_proc": null
},
"privileged": true,
"capabilities": [null
],
"rootfs": {"readonly": null
}
},
"resources": {"cpu": {"shares": null,
"cpus": null
},
"ram": {"limit": null,
"reserve": null,
"swappiness": null
}
},
"integrations": {"webhooks": {"events": null,
"config": null
},
"lets_encrypt": {"certificate_path": null,
"chain_path": null,
"key_path": null,
"bundle_path": null,
"additional_certs_path": null
},
"files": [{ }
],
"backups": {"integration_id": null,
"backup": null,
"restore": null,
"retention": null
},
"shared_file_systems": {"property1": null,
"property2": null
},
"logs": {"drain": null
}
}
},
"role": "conductor",
"volumes": [{"local": {"max_size": null,
"storage_pool": null
},
"destination": "string",
"read_only": true,
"block_device": true,
"remote_access": {"enable": null,
"ips": null,
"webhook": null,
"password": null
}
}
],
"deprecate": true,
"lock": true
}
},
"services": {"discovery": {"service": {"enable": true,
"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"
]
}
},
"loadbalancer": {"service": {"enable": true,
"high_availability": true,
"auto_update": true
},
"config": {"ipv4": true,
"ipv6": true,
"type": "haproxy",
"details": {"default": {"frontend": null,
"backend": null
},
"ports": {"property1": null,
"property2": null
}
},
"bind_host": true
}
},
"scheduler": {"service": {"enable": true,
"high_availability": true,
"auto_update": true
},
"config": {"public": true,
"access_keys": [{"name": null,
"secret": null,
"ips": null
}
]
}
},
"vpn": {"service": {"enable": true,
"high_availability": true,
"auto_update": true
},
"config": {"auth": {"webhook": "string",
"cycle_accounts": true,
"vpn_accounts": true
},
"allow_internet": true
}
}
},
"annotations": {"property1": null,
"property2": null
}
},
"about": {"version": "string",
"description": "string",
"git_commit": {"hash": "string",
"message": "string",
"time": "2021-01-30T08:30:00Z",
"author": {"name": "string",
"email": "string"
}
}
},
"instructions": {"git": {"type": "hash",
"value": "string"
},
"variables": {"property1": "string",
"property2": "string"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
}

List Builds

Requires the stacks-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

stackId

required

string

The ID of the Stack.

query Parameters

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

Responses

200

Returns a list of Stack Builds.

default

General error response from the platform

get/v1/stacks/{stackId}/builds

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"stack_id": "string",
"spec": {"version": "1.0",
"about": {"version": "string",
"description": "string"
},
"scoped_variables": [{"identifier": "string",
"scope": {"containers": {"global": null,
"ids": null,
"identifiers": null
}
},
"access": {"env_variable": {"key": null
},
"internal_api": {"duration": null
},
"file": {"decode": null,
"path": null
}
},
"source": {"type": "url",
"details": {"url": null,
"headers": null,
"auth_token_url": null
}
}
}
],
"containers": {"property1": {"name": "string",
"image": {"name": "string",
"origin": {"type": null,
"details": { }
},
"build": {"args": null
},
"builder": {"integration_id": null
}
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": {"public": null,
"hostname": null,
"ports": null
},
"deploy": {"instances": null,
"strategy": null,
"function": null,
"stateful": null,
"constraints": null,
"shutdown": null,
"startup": null,
"update": null,
"restart": null,
"health_check": null,
"telemetry": null
},
"scaling": {"autoscale_group": null,
"instances": null,
"window": null,
"thresholds": null
},
"runtime": {"workdir": null,
"command": null,
"environment_vars": null,
"namespaces": null,
"sysctl": null,
"rlimits": null,
"seccomp": null,
"host": null,
"privileged": null,
"capabilities": null,
"rootfs": null
},
"resources": {"cpu": null,
"ram": null
},
"integrations": {"webhooks": null,
"lets_encrypt": null,
"files": null,
"backups": null,
"shared_file_systems": null,
"logs": null
}
},
"role": "conductor",
"volumes": [{"local": null,
"destination": null,
"read_only": null,
"block_device": null,
"remote_access": null
}
],
"deprecate": true,
"lock": true
},
"property2": {"name": "string",
"image": {"name": "string",
"origin": {"type": null,
"details": { }
},
"build": {"args": null
},
"builder": {"integration_id": null
}
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": {"public": null,
"hostname": null,
"ports": null
},
"deploy": {"instances": null,
"strategy": null,
"function": null,
"stateful": null,
"constraints": null,
"shutdown": null,
"startup": null,
"update": null,
"restart": null,
"health_check": null,
"telemetry": null
},
"scaling": {"autoscale_group": null,
"instances": null,
"window": null,
"thresholds": null
},
"runtime": {"workdir": null,
"command": null,
"environment_vars": null,
"namespaces": null,
"sysctl": null,
"rlimits": null,
"seccomp": null,
"host": null,
"privileged": null,
"capabilities": null,
"rootfs": null
},
"resources": {"cpu": null,
"ram": null
},
"integrations": {"webhooks": null,
"lets_encrypt": null,
"files": null,
"backups": null,
"shared_file_systems": null,
"logs": null
}
},
"role": "conductor",
"volumes": [{"local": null,
"destination": null,
"read_only": null,
"block_device": null,
"remote_access": null
}
],
"deprecate": true,
"lock": true
}
},
"services": {"discovery": {"service": {"enable": true,
"high_availability": true,
"auto_update": true
},
"config": {"empty_set_delay": "72h45m2s",
"hosts": {"property1": { },
"property2": { }
},
"custom_resolvers": [null
]
}
},
"loadbalancer": {"service": {"enable": true,
"high_availability": true,
"auto_update": true
},
"config": {"ipv4": true,
"ipv6": true,
"type": "haproxy",
"details": {"default": null,
"ports": null
},
"bind_host": true
}
},
"scheduler": {"service": {"enable": true,
"high_availability": true,
"auto_update": true
},
"config": {"public": true,
"access_keys": [null
]
}
},
"vpn": {"service": {"enable": true,
"high_availability": true,
"auto_update": true
},
"config": {"auth": {"webhook": null,
"cycle_accounts": null,
"vpn_accounts": null
},
"allow_internet": true
}
}
},
"annotations": {"property1": null,
"property2": null
}
},
"about": {"version": "string",
"description": "string",
"git_commit": {"hash": "string",
"message": "string",
"time": "2021-01-30T08:30:00Z",
"author": {"name": "string",
"email": "string"
}
}
},
"instructions": {"git": {"type": "hash",
"value": "string"
},
"variables": {"property1": "string",
"property2": "string"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
]
}

Create Build

Requires the stacks-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

stackId

required

string

The ID of the Stack

Request Body schema: application/json

Parameters for creating a new Stack Build.

	object (StackBuildAbout) Information about the stack build.
	object (StackBuildInstructions) Additional instructions used when generating this stack build.

Responses

201

Returns a Stack Build.

default

General error response from the platform

post/v1/stacks/{stackId}/builds

Request samples

Payload

application/json

{"about": {"version": "string",
"description": "string",
"git_commit": {"hash": "string",
"message": "string",
"time": "2021-01-30T08:30:00Z",
"author": {"name": "string",
"email": "string"
}
}
},
"instructions": {"git": {"type": "hash",
"value": "string"
},
"variables": {"property1": "string",
"property2": "string"
}
}
}

Response samples

201
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"stack_id": "string",
"spec": {"version": "1.0",
"about": {"version": "string",
"description": "string"
},
"scoped_variables": [{"identifier": "string",
"scope": {"containers": {"global": true,
"ids": [null
],
"identifiers": [null
]
}
},
"access": {"env_variable": {"key": "string"
},
"internal_api": {"duration": "72h45m2s"
},
"file": {"decode": true,
"path": "/var/run/cycle/variables/<myVariable>"
}
},
"source": {"type": "url",
"details": {"url": "string",
"headers": {"property1": null,
"property2": null
},
"auth_token_url": "string"
}
}
}
],
"containers": {"property1": {"name": "string",
"image": {"name": "string",
"origin": {"type": "docker-hub",
"details": {"existing": null,
"target": null,
"username": null,
"token": null
}
},
"build": {"args": {"property1": null,
"property2": null
}
},
"builder": {"integration_id": "my-image-source"
}
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": "80:80"
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": null,
"max_shard_concurrency": null,
"max_runtime": null,
"max_queue_time": null
},
"stateful": {"options": { }
},
"constraints": {"node": { }
},
"shutdown": {"graceful_timeout": null,
"signals": null
},
"startup": {"delay": null
},
"update": {"stagger": null
},
"restart": {"condition": null,
"delay": null,
"max_attempts": null
},
"health_check": {"command": null,
"retries": null,
"interval": null,
"timeout": null,
"restart": null,
"delay": null
},
"telemetry": {"retention": null,
"interval": null,
"webhook": null,
"disable": null
}
},
"scaling": {"autoscale_group": "string",
"instances": {"max": null,
"max_server": null,
"min_ttl": null
},
"window": "72h45m2s",
"thresholds": [null
]
},
"runtime": {"workdir": "string",
"command": {"path": null,
"args": null
},
"environment_vars": {"property1": null,
"property2": null
},
"namespaces": [null
],
"sysctl": {"property1": null,
"property2": null
},
"rlimits": {"property1": { },
"property2": { }
},
"seccomp": {"disable": null,
"rules": null
},
"host": {"expose_proc": null
},
"privileged": true,
"capabilities": [null
],
"rootfs": {"readonly": null
}
},
"resources": {"cpu": {"shares": null,
"cpus": null
},
"ram": {"limit": null,
"reserve": null,
"swappiness": null
}
},
"integrations": {"webhooks": {"events": null,
"config": null
},
"lets_encrypt": {"certificate_path": null,
"chain_path": null,
"key_path": null,
"bundle_path": null,
"additional_certs_path": null
},
"files": [{ }
],
"backups": {"integration_id": null,
"backup": null,
"restore": null,
"retention": null
},
"shared_file_systems": {"property1": null,
"property2": null
},
"logs": {"drain": null
}
}
},
"role": "conductor",
"volumes": [{"local": {"max_size": null,
"storage_pool": null
},
"destination": "string",
"read_only": true,
"block_device": true,
"remote_access": {"enable": null,
"ips": null,
"webhook": null,
"password": null
}
}
],
"deprecate": true,
"lock": true
},
"property2": {"name": "string",
"image": {"name": "string",
"origin": {"type": "docker-hub",
"details": {"existing": null,
"target": null,
"username": null,
"token": null
}
},
"build": {"args": {"property1": null,
"property2": null
}
},
"builder": {"integration_id": "my-image-source"
}
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": "80:80"
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": null,
"max_shard_concurrency": null,
"max_runtime": null,
"max_queue_time": null
},
"stateful": {"options": { }
},
"constraints": {"node": { }
},
"shutdown": {"graceful_timeout": null,
"signals": null
},
"startup": {"delay": null
},
"update": {"stagger": null
},
"restart": {"condition": null,
"delay": null,
"max_attempts": null
},
"health_check": {"command": null,
"retries": null,
"interval": null,
"timeout": null,
"restart": null,
"delay": null
},
"telemetry": {"retention": null,
"interval": null,
"webhook": null,
"disable": null
}
},
"scaling": {"autoscale_group": "string",
"instances": {"max": null,
"max_server": null,
"min_ttl": null
},
"window": "72h45m2s",
"thresholds": [null
]
},
"runtime": {"workdir": "string",
"command": {"path": null,
"args": null
},
"environment_vars": {"property1": null,
"property2": null
},
"namespaces": [null
],
"sysctl": {"property1": null,
"property2": null
},
"rlimits": {"property1": { },
"property2": { }
},
"seccomp": {"disable": null,
"rules": null
},
"host": {"expose_proc": null
},
"privileged": true,
"capabilities": [null
],
"rootfs": {"readonly": null
}
},
"resources": {"cpu": {"shares": null,
"cpus": null
},
"ram": {"limit": null,
"reserve": null,
"swappiness": null
}
},
"integrations": {"webhooks": {"events": null,
"config": null
},
"lets_encrypt": {"certificate_path": null,
"chain_path": null,
"key_path": null,
"bundle_path": null,
"additional_certs_path": null
},
"files": [{ }
],
"backups": {"integration_id": null,
"backup": null,
"restore": null,
"retention": null
},
"shared_file_systems": {"property1": null,
"property2": null
},
"logs": {"drain": null
}
}
},
"role": "conductor",
"volumes": [{"local": {"max_size": null,
"storage_pool": null
},
"destination": "string",
"read_only": true,
"block_device": true,
"remote_access": {"enable": null,
"ips": null,
"webhook": null,
"password": null
}
}
],
"deprecate": true,
"lock": true
}
},
"services": {"discovery": {"service": {"enable": true,
"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"
]
}
},
"loadbalancer": {"service": {"enable": true,
"high_availability": true,
"auto_update": true
},
"config": {"ipv4": true,
"ipv6": true,
"type": "haproxy",
"details": {"default": {"frontend": null,
"backend": null
},
"ports": {"property1": null,
"property2": null
}
},
"bind_host": true
}
},
"scheduler": {"service": {"enable": true,
"high_availability": true,
"auto_update": true
},
"config": {"public": true,
"access_keys": [{"name": null,
"secret": null,
"ips": null
}
]
}
},
"vpn": {"service": {"enable": true,
"high_availability": true,
"auto_update": true
},
"config": {"auth": {"webhook": "string",
"cycle_accounts": true,
"vpn_accounts": true
},
"allow_internet": true
}
}
},
"annotations": {"property1": null,
"property2": null
}
},
"about": {"version": "string",
"description": "string",
"git_commit": {"hash": "string",
"message": "string",
"time": "2021-01-30T08:30:00Z",
"author": {"name": "string",
"email": "string"
}
}
},
"instructions": {"git": {"type": "hash",
"value": "string"
},
"variables": {"property1": "string",
"property2": "string"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
}

Get Stack Build

Requires the stacks-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

stackId required	string The ID of the Stack.
buildId required	string The ID of the Build.

Responses

200

Returns a Stack Build.

default

General error response from the platform

get/v1/stacks/{stackId}/builds/{buildId}

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"stack_id": "string",
"spec": {"version": "1.0",
"about": {"version": "string",
"description": "string"
},
"scoped_variables": [{"identifier": "string",
"scope": {"containers": {"global": true,
"ids": [null
],
"identifiers": [null
]
}
},
"access": {"env_variable": {"key": "string"
},
"internal_api": {"duration": "72h45m2s"
},
"file": {"decode": true,
"path": "/var/run/cycle/variables/<myVariable>"
}
},
"source": {"type": "url",
"details": {"url": "string",
"headers": {"property1": null,
"property2": null
},
"auth_token_url": "string"
}
}
}
],
"containers": {"property1": {"name": "string",
"image": {"name": "string",
"origin": {"type": "docker-hub",
"details": {"existing": null,
"target": null,
"username": null,
"token": null
}
},
"build": {"args": {"property1": null,
"property2": null
}
},
"builder": {"integration_id": "my-image-source"
}
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": "80:80"
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": null,
"max_shard_concurrency": null,
"max_runtime": null,
"max_queue_time": null
},
"stateful": {"options": { }
},
"constraints": {"node": { }
},
"shutdown": {"graceful_timeout": null,
"signals": null
},
"startup": {"delay": null
},
"update": {"stagger": null
},
"restart": {"condition": null,
"delay": null,
"max_attempts": null
},
"health_check": {"command": null,
"retries": null,
"interval": null,
"timeout": null,
"restart": null,
"delay": null
},
"telemetry": {"retention": null,
"interval": null,
"webhook": null,
"disable": null
}
},
"scaling": {"autoscale_group": "string",
"instances": {"max": null,
"max_server": null,
"min_ttl": null
},
"window": "72h45m2s",
"thresholds": [null
]
},
"runtime": {"workdir": "string",
"command": {"path": null,
"args": null
},
"environment_vars": {"property1": null,
"property2": null
},
"namespaces": [null
],
"sysctl": {"property1": null,
"property2": null
},
"rlimits": {"property1": { },
"property2": { }
},
"seccomp": {"disable": null,
"rules": null
},
"host": {"expose_proc": null
},
"privileged": true,
"capabilities": [null
],
"rootfs": {"readonly": null
}
},
"resources": {"cpu": {"shares": null,
"cpus": null
},
"ram": {"limit": null,
"reserve": null,
"swappiness": null
}
},
"integrations": {"webhooks": {"events": null,
"config": null
},
"lets_encrypt": {"certificate_path": null,
"chain_path": null,
"key_path": null,
"bundle_path": null,
"additional_certs_path": null
},
"files": [{ }
],
"backups": {"integration_id": null,
"backup": null,
"restore": null,
"retention": null
},
"shared_file_systems": {"property1": null,
"property2": null
},
"logs": {"drain": null
}
}
},
"role": "conductor",
"volumes": [{"local": {"max_size": null,
"storage_pool": null
},
"destination": "string",
"read_only": true,
"block_device": true,
"remote_access": {"enable": null,
"ips": null,
"webhook": null,
"password": null
}
}
],
"deprecate": true,
"lock": true
},
"property2": {"name": "string",
"image": {"name": "string",
"origin": {"type": "docker-hub",
"details": {"existing": null,
"target": null,
"username": null,
"token": null
}
},
"build": {"args": {"property1": null,
"property2": null
}
},
"builder": {"integration_id": "my-image-source"
}
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": {"public": "enable",
"hostname": "string",
"ports": "80:80"
},
"deploy": {"instances": 0,
"strategy": "resource-density",
"function": {"max_pool_size": null,
"max_shard_concurrency": null,
"max_runtime": null,
"max_queue_time": null
},
"stateful": {"options": { }
},
"constraints": {"node": { }
},
"shutdown": {"graceful_timeout": null,
"signals": null
},
"startup": {"delay": null
},
"update": {"stagger": null
},
"restart": {"condition": null,
"delay": null,
"max_attempts": null
},
"health_check": {"command": null,
"retries": null,
"interval": null,
"timeout": null,
"restart": null,
"delay": null
},
"telemetry": {"retention": null,
"interval": null,
"webhook": null,
"disable": null
}
},
"scaling": {"autoscale_group": "string",
"instances": {"max": null,
"max_server": null,
"min_ttl": null
},
"window": "72h45m2s",
"thresholds": [null
]
},
"runtime": {"workdir": "string",
"command": {"path": null,
"args": null
},
"environment_vars": {"property1": null,
"property2": null
},
"namespaces": [null
],
"sysctl": {"property1": null,
"property2": null
},
"rlimits": {"property1": { },
"property2": { }
},
"seccomp": {"disable": null,
"rules": null
},
"host": {"expose_proc": null
},
"privileged": true,
"capabilities": [null
],
"rootfs": {"readonly": null
}
},
"resources": {"cpu": {"shares": null,
"cpus": null
},
"ram": {"limit": null,
"reserve": null,
"swappiness": null
}
},
"integrations": {"webhooks": {"events": null,
"config": null
},
"lets_encrypt": {"certificate_path": null,
"chain_path": null,
"key_path": null,
"bundle_path": null,
"additional_certs_path": null
},
"files": [{ }
],
"backups": {"integration_id": null,
"backup": null,
"restore": null,
"retention": null
},
"shared_file_systems": {"property1": null,
"property2": null
},
"logs": {"drain": null
}
}
},
"role": "conductor",
"volumes": [{"local": {"max_size": null,
"storage_pool": null
},
"destination": "string",
"read_only": true,
"block_device": true,
"remote_access": {"enable": null,
"ips": null,
"webhook": null,
"password": null
}
}
],
"deprecate": true,
"lock": true
}
},
"services": {"discovery": {"service": {"enable": true,
"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"
]
}
},
"loadbalancer": {"service": {"enable": true,
"high_availability": true,
"auto_update": true
},
"config": {"ipv4": true,
"ipv6": true,
"type": "haproxy",
"details": {"default": {"frontend": null,
"backend": null
},
"ports": {"property1": null,
"property2": null
}
},
"bind_host": true
}
},
"scheduler": {"service": {"enable": true,
"high_availability": true,
"auto_update": true
},
"config": {"public": true,
"access_keys": [{"name": null,
"secret": null,
"ips": null
}
]
}
},
"vpn": {"service": {"enable": true,
"high_availability": true,
"auto_update": true
},
"config": {"auth": {"webhook": "string",
"cycle_accounts": true,
"vpn_accounts": true
},
"allow_internet": true
}
}
},
"annotations": {"property1": null,
"property2": null
}
},
"about": {"version": "string",
"description": "string",
"git_commit": {"hash": "string",
"message": "string",
"time": "2021-01-30T08:30:00Z",
"author": {"name": "string",
"email": "string"
}
}
},
"instructions": {"git": {"type": "hash",
"value": "string"
},
"variables": {"property1": "string",
"property2": "string"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
}

Delete Stack Build

Requires the stacks-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

stackId required	string The ID of the Stack.
buildId required	string The ID of the Build.

Responses

200

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/stacks/{stackId}/builds/{buildId}

Response samples

200
default

application/json

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

Create Stack Build Job

Requires the stacks-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

stackId required	string The ID of the Stack.
buildId required	string The ID of the Build.

Request Body schema: application/json

Parameters for creating a new Stack Build Job.

action

required

string

The job to do.

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/stacks/{stackId}/builds/{buildId}/tasks

Request samples

Payload

application/json

{"action": "generate"
}

Response samples

202
default

application/json

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

➔ Next to Virtual Machines

Stack Builds

Look Up Stack Build

path Parameters

List Builds

path Parameters

query Parameters

Filter Field

Create Build

path Parameters

Request Body schema: application/json

Get Stack Build

path Parameters

Delete Stack Build

path Parameters

Create Stack Build Job

path Parameters

Request Body schema: application/json