portainer

v0.2.1 · by Animus · 2026-09-27 · sha256 287c6abe6aab

Portainer CE/BE API — observe and control your own Docker infrastructure: environments, stacks, compose definitions; v0.2 adds redeploy/start/stop write actions (approval-gated). Self-hosted: base_url must point at YOUR Portainer instance.

Commands (11)

Command Kind Description
status action Portainer version + instance id. Works even without a valid API key — pre-flight/clock sanity.
endpoints list action Environments (Docker/Swarm/K8s) known to this Portainer, with id/name/type/url/group.
stacks list action Stacks with id/name/type/status/endpoint. Optional filters: endpoint_id, name.
stack get action One stack in full: status, dates, git metadata, webhook presence.
stack file action The stack's compose definition (stackFileContent string).
stack start action Start a stopped stack. Write lane: requires writes_enabled=true state and confirm="<stack name>".
stack stop action Stop an active stack (availability only; volumes/definitions untouched). Write lane gates apply.
stack redeploy action Git-backed stacks: pull current source and redeploy (prune always false). Write lane gates apply.
stack update action Replace a stack's stored compose definition. Result carries a line diff of the change. Write lane gates apply.
webhooks list action All webhooks with tokens masked.
webhook delete action Delete a webhook by id. Confirm = the webhook id as a string. Write lane gates apply.

State Schema

Key Type Secret Default
api_key string yes
base_url string no
writes_enabled string no false
Back

Version History

Version Date SHA-256
0.2.1 2026-09-27 287c6abe6aab
0.2.0 2026-09-27 4dfb41691623
0.1.0 2026-09-26 2b2c13ff1ae8