Deployments and containers
Ce contenu n’est pas encore disponible dans votre langue.
Creating, changing, scaling, rolling out and rolling back a deployment, and the containers a deployment runs.
Every address below is served under the control plane’s base URL. Permission is the guard the route is registered with; who holds it is read from the control plane’s own grant, so it cannot drift from what the server does. A dash means the route carries no permission guard of its own — the access tier below the table is then the whole of what stands in front of it.
Generated from Route. Hand edits to this table are overwritten on the next build — change the Go doc comment, or the generator.
| Route | Permission | Who holds it | Body |
|---|---|---|---|
GET /api/v1/archives/deployments |
backups:read |
developer, operator, readonly, support |
— |
GET /api/v1/archives/deployments/{name} |
backups:read |
developer, operator, readonly, support |
— |
GET /api/v1/archives/deployments/{name}/download |
backups:read |
developer, operator, readonly, support |
— |
GET /api/v1/archives/deployments/{name}/latest |
backups:read |
developer, operator, readonly, support |
— |
POST /api/v1/archives/deployments/{name}/restore |
backups:restore |
operator |
— |
GET /api/v1/archives/deployments/{name}/versions/{commit} |
backups:read |
developer, operator, readonly, support |
— |
GET /api/v1/archives/stats |
backups:read |
developer, operator, readonly, support |
— |
GET /api/v1/canaries |
canary:read |
developer, operator, readonly, support |
— |
GET /api/v1/canary/{name} |
canary:read |
developer, operator, readonly, support |
— |
POST /api/v1/canary/{name} |
canary:manage |
operator |
— |
POST /api/v1/canary/{name}/pause |
canary:manage |
operator |
— |
POST /api/v1/canary/{name}/promote |
canary:manage |
operator |
— |
POST /api/v1/canary/{name}/resume |
canary:manage |
operator |
— |
POST /api/v1/canary/{name}/rollback |
canary:manage |
operator |
— |
PUT /api/v1/canary/{name}/weight |
canary:manage |
operator |
— |
GET /api/v1/containers |
containers:read |
developer, operator, readonly, support |
returns Container |
DELETE /api/v1/containers/{id} |
containers:manage |
operator |
— |
GET /api/v1/containers/{id} |
containers:read |
developer, operator, readonly, support |
— |
POST /api/v1/containers/{id}/exec |
containers:exec |
operator |
— |
GET /api/v1/containers/{id}/logs |
containers:logs |
developer, operator, support |
— |
POST /api/v1/containers/{id}/restart |
containers:manage |
operator |
— |
POST /api/v1/containers/{id}/simulate-crash |
debug:access |
operator |
— |
POST /api/v1/containers/{id}/simulate-high-cpu |
debug:access |
operator |
— |
POST /api/v1/containers/{id}/simulate-high-memory |
debug:access |
operator |
— |
POST /api/v1/containers/{id}/simulate-network-delay |
debug:access |
operator |
— |
POST /api/v1/containers/{id}/simulate-network-loss |
debug:access |
operator |
— |
POST /api/v1/containers/{id}/stop |
containers:manage |
operator |
— |
GET /api/v1/deployments |
deployments:read |
developer, operator, readonly, support |
returns Deployment |
POST /api/v1/deployments |
deployments:create |
developer |
sends Deployment, returns Deployment |
POST /api/v1/deployments/bulk-delete |
deployments:delete |
developer |
— |
POST /api/v1/deployments/bulk-edit |
deployments:update |
developer, operator |
— |
POST /api/v1/deployments/bulk-restart |
deployments:restart |
operator |
— |
POST /api/v1/deployments/bulk-scale |
deployments:scale |
operator |
— |
POST /api/v1/deployments/bulk-start |
deployments:start |
an administrator only, through the wildcard grant | — |
POST /api/v1/deployments/bulk-stop |
deployments:stop |
an administrator only, through the wildcard grant | — |
POST /api/v1/deployments/dry-run |
deployments:create |
developer |
— |
GET /api/v1/deployments/export |
deployments:read |
developer, operator, readonly, support |
— |
POST /api/v1/deployments/import |
deployments:create |
developer |
— |
GET /api/v1/deployments/metrics |
deployments:read |
developer, operator, readonly, support |
— |
DELETE /api/v1/deployments/{name} |
deployments:delete |
developer |
— |
GET /api/v1/deployments/{name} |
deployments:read |
developer, operator, readonly, support |
returns Deployment |
PUT /api/v1/deployments/{name} |
deployments:update |
developer, operator |
sends Deployment, returns Deployment |
GET /api/v1/deployments/{name}/canary |
canary:read |
developer, operator, readonly, support |
— |
POST /api/v1/deployments/{name}/canary/pause |
canary:manage |
operator |
— |
POST /api/v1/deployments/{name}/canary/promote |
canary:manage |
operator |
— |
POST /api/v1/deployments/{name}/canary/resume |
canary:manage |
operator |
— |
POST /api/v1/deployments/{name}/canary/rollback |
canary:manage |
operator |
— |
POST /api/v1/deployments/{name}/canary/start |
canary:manage |
operator |
— |
POST /api/v1/deployments/{name}/dry-run |
deployments:update |
developer, operator |
— |
GET /api/v1/deployments/{name}/history |
deployments:read |
developer, operator, readonly, support |
— |
GET /api/v1/deployments/{name}/metrics |
deployments:read |
developer, operator, readonly, support |
— |
POST /api/v1/deployments/{name}/restart |
deployments:restart |
operator |
— |
POST /api/v1/deployments/{name}/rollback |
deployments:rollback |
operator |
— |
POST /api/v1/deployments/{name}/scale |
deployments:scale |
operator |
— |
POST /api/v1/deployments/{name}/secrets/rotate |
vault:manage |
developer |
— |
POST /api/v1/deployments/{name}/start |
deployments:manage |
operator |
— |
POST /api/v1/deployments/{name}/stop |
deployments:manage |
operator |
— |
GET /api/v1/images |
images:read |
developer, operator, readonly, support |
— |
GET /api/v1/manifests |
config:read |
developer, operator, readonly, support |
— |
GET /api/v1/manifests/get |
config:read |
developer, operator, readonly, support |
— |
POST /api/v1/manifests/upload |
config:write |
an administrator only, through the wildcard grant | — |
GET /api/v1/priority-classes |
config:read |
developer, operator, readonly, support |
— |
POST /api/v1/prune |
admin |
an administrator only, through the wildcard grant | — |
GET /api/v1/prune/preview |
admin |
an administrator only, through the wildcard grant | — |
GET /api/v1/scaling-history |
scaling:read |
developer, operator, readonly, support |
— |
GET /api/v1/scaling-history/{deploymentName} |
scaling:read |
developer, operator, readonly, support |
— |
GET /api/v1/scaling-policies |
scaling:read |
developer, operator, readonly, support |
— |
DELETE /api/v1/scaling-policies/{deploymentName} |
scaling:configure |
operator |
— |
GET /api/v1/scaling-policies/{deploymentName} |
scaling:read |
developer, operator, readonly, support |
— |
POST /api/v1/scaling-policies/{deploymentName} |
scaling:configure |
operator |
— |
GET /api/v1/scaling-stats |
scaling:read |
developer, operator, readonly, support |
— |
GET /api/v1/stacks |
containers:read |
developer, operator, readonly, support |
— |
GET /api/v1/stacks/{name} |
containers:read |
developer, operator, readonly, support |
— |
POST /api/v1/stacks/{name}/migrate |
admin |
an administrator only, through the wildcard grant | — |
POST /api/v1/stacks/{name}/migrate-async |
admin |
an administrator only, through the wildcard grant | — |
GET /api/v1/stacks/{name}/migration-preview |
containers:read |
developer, operator, readonly, support |
— |
Who can reach these at all
Section titled “Who can reach these at all”authenticated — Behind authentication, cross-site-request-forgery validation and tenant extraction. Every call acts inside exactly one tenant.
Reachable only by an administrator
Section titled “Reachable only by an administrator”No role holds the permissions below explicitly. They are satisfied by the administrator’s wildcard grant and by nothing else, so an operator or a developer cannot call these routes however their tenant is configured. That is a role-model question rather than a documentation one; it is recorded here because a reader planning around it needs to know before they try.
POST /api/v1/deployments/bulk-start— needsdeployments:startPOST /api/v1/deployments/bulk-stop— needsdeployments:stopPOST /api/v1/manifests/upload— needsconfig:writePOST /api/v1/prune— needsadminGET /api/v1/prune/preview— needsadminPOST /api/v1/stacks/{name}/migrate— needsadminPOST /api/v1/stacks/{name}/migrate-async— needsadmin
Registered more than once
Section titled “Registered more than once”Each route below is registered at more than one place in the control plane. The router serves the first registration; the rest are unreachable. Where two of them carry different permissions the table above shows the one the router uses, and both are listed here — a second registration is where a permission a reader expects to apply turns out not to.
GET /api/v1/canaries
pkg/api/server.go:599— the guardcanary:readpkg/api/server.go:650— the guardcanary:read