/
/PortainerCE API
DocsSign in
Sign in
  • APIs
  • Generators
  • Stacks
  • Projects
  • Docs
  • History
  • Schema
Checked 2h ago · Updated 3d ago
auth3
backup2
custom_templates9
docker3
edge_agent3
edge_groups5
edge_jobs11
edge_stacks9
endpoint_groups7
endpoints19
gitops14
helm11
kubernetes107
ldap1
motd1
registries7
resource_controls3
roles1
settings3
ssl2
stacks22
  • getList stacks
  • getInspect a stack
  • putUpdate a stack
  • deleteRemove a stack
  • putAssociate an orphaned stack to a new environment(endpoint)
  • getRetrieve the content of the Stack file for the specified stack
  • postUpdate a stack's Git configs
  • putRedeploy a stack
  • postMigrate a stack to another environment(endpoint)
  • postStarts a stopped Stack
  • postStop a running Stack
  • postDeploy a new kubernetes stack from a git repository
  • postDeploy a new kubernetes stack from a file
  • postDeploy a new kubernetes stack from a url
  • postDeploy a new compose stack from a file
  • postDeploy a new compose stack from repository
  • postDeploy a new compose stack from a text
  • postDeploy a new swarm stack from a file
  • postDeploy a new swarm stack from a git repository
  • postDeploy a new swarm stack from a text
  • deleteRemove Kubernetes stacks by name
  • postWebhook for triggering stack updates from git
status1
system5
tags3
team_memberships5
teams5
templates2
upload1
users14
webhooks5
websocket4
    stacks

    Stop a running Stack

    Stop a running Stack. Access policy: authenticated

    post/stacks/{id}/stop

    Path parameters

    idinteger required

    Stack identifier

    Query parameters

    endpointIdinteger required

    Environment identifier

    Response

    Success

    Changes