Field | Type | Create | Update | Default | Notes |
---|---|---|---|---|---|
binding | binding | Optional | Yes | - | |
description | string | Optional | Yes | - | |
dockerCompose | string | Optional | - | - | |
environment | map[string] | Optional | - | - | |
externalId | string | Optional | Yes | - | |
group | string | Optional | Yes | - | |
name | string | Yes | Yes | - | |
outputs | map[string] | Optional | Yes | - | |
previousEnvironment | map[string] | Optional | Yes | - | |
previousExternalId | string | Optional | Yes | - | |
rancherCompose | string | Optional | - | - | |
startOnCreate | boolean | Optional | - | - |
Field | Type | Notes |
---|---|---|
healthState | string | |
id | int | The unique identifier for the stack |
serviceIds | array[service] | |
system | boolean |
Please read more about the common resource fields. These fields are read only and applicable to almost every resource. We have segregated them from the list above.
CreatePOST: /v2-beta/projects/${PROJECT_ID}/stacks
DeleteDELETE: /v2-beta/projects/${PROJECT_ID}/stacks/${ID}
UpdatePUT: /v2-beta/projects/${PROJECT_ID}/stacks/${ID}
activateservices
POST: /v2-beta/projects/${PROJECT_ID}/stacks/${ID}?action=activateservices
addoutputs
POST: /v2-beta/projects/${PROJECT_ID}/stacks/${ID}?action=addoutputs
Input: AddOutputsInput
Field | Type | Required | Default | Notes |
---|---|---|---|---|
outputs | map[string] | Yes |
Output: An updated copy of the stack resource
cancelupgrade
POST: /v2-beta/projects/${PROJECT_ID}/stacks/${ID}?action=cancelupgrade
deactivateservices
POST: /v2-beta/projects/${PROJECT_ID}/stacks/${ID}?action=deactivateservices
error
POST: /v2-beta/projects/${PROJECT_ID}/stacks/${ID}?action=error
exportconfig
POST: /v2-beta/projects/${PROJECT_ID}/stacks/${ID}?action=exportconfig
Input: ComposeConfigInput
Field | Type | Required | Default | Notes |
---|---|---|---|---|
serviceIds | array[service] | No |
Output: An updated copy of the composeConfig resource
finishupgrade
POST: /v2-beta/projects/${PROJECT_ID}/stacks/${ID}?action=finishupgrade
rollback
POST: /v2-beta/projects/${PROJECT_ID}/stacks/${ID}?action=rollback
upgrade
POST: /v2-beta/projects/${PROJECT_ID}/stacks/${ID}?action=upgrade
Input: StackUpgrade
Field | Type | Required | Default | Notes |
---|---|---|---|---|
dockerCompose | No | |||
environment | map[string] | No | ||
externalId | No | |||
rancherCompose | No |
Output: An updated copy of the stack resource