bignellrp/Portainer API Action
Deploy and manage Docker containers and stacks via Portainer API
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Feb 15, 2026
- License
- MIT
Pinned Snippet
uses: bignellrp/portainer-api-action@bd85914af4924458f269f5799c204e2073f78c1d # no releases — HEAD as of 2026-07-11tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| portainer_url | Portainer instance URL (e.g., https://portainer.example.com) | yes | — |
| portainer_api_key | Portainer API access token | yes | — |
| stack_name | Name of the stack to deploy/update | yes | ${GITHUB_REPOSITORY#*/} |
| stack_file | Path to docker-compose stack file | no | docker-compose.yml |
| endpoint_id | Portainer endpoint ID | no | 2 |
| stack_type | Portainer stack type (2 = Compose, 1 = Swarm) | no | 2 |
| action | Action to perform: deploy, update, or redeploy | no | redeploy |
| env_vars | Environment variables as JSON string (e.g., {"KEY": "value"}) | no | {} |
| prune | Prune services not defined in the stack file | no | true |
| x_registry_auth | Optional X-Registry-Auth header value (base64). Useful for private registries. | no | "" |
| registry_match | Optional regex to auto-select a Portainer registry (matches Name or URL). Sets X-Registry-Auth if found. | no | "" |
Outputs
| name | description |
|---|---|
| stack_id | ID of the deployed/updated stack |
| status | Status of the operation |