API reference
Explore the Munchii REST API for managing release pipelines, creating releases, uploading artifacts, and tracking deployment progress.
Base URL: https://api.munchii.com
Resources
Identity & Access
- Me
/meGet the ID of the authenticated caller.
- Sessions
/sessionsMunchii supports programmatic authentication through GitHub OIDC and AWS IAM, alongside browser sessions and read-only sharing sessions.
- Spaces
/spacesCreate and manage spaces that organize pipelines and control access to them.
- Shares
/spaces/{spaceId}/sharesCreate, list, and revoke links that give others read-only access to a pipeline.
Pipeline Configuration
- Pipelines
/spaces/{spaceId}/pipelinesManage release pipelines within a space and enable or disable execution.
- Topology
/spaces/{spaceId}/pipelines/{pipelineName}/topologyRead or replace the groups, targets, and dependencies that determine how releases flow through a pipeline.
- Pipeline step mode
/spaces/{spaceId}/pipelines/{pipelineName}Use step mode when you want to review what would run next and decide when to advance a rollout. Each step uses the pipeline's normal scheduling rules and may start multiple eligible target runs. The pipeline advances only when an operator requests a scheduling step.
- Groups
/spaces/{spaceId}/pipelines/{pipelineName}/groupsManage the groups that organize targets and apply scheduling rules within a pipeline.
- Targets
/spaces/{spaceId}/pipelines/{pipelineName}/targetsManage the units of work in a pipeline, control whether they can run, and retry failed work.
Releases & Execution
- Drafts
/spaces/{spaceId}/pipelines/{pipelineName}/draftA release draft is a staging area for the artifacts and changes that will become a pipeline release. It lets a CI workflow prepare a release incrementally without starting deployment before everything is ready.
- Artifacts
/spaces/{spaceId}/pipelines/{pipelineName}/draft/artifactsRequest an upload URL for a draft artifact or download an artifact associated with a task.
- Releases
/spaces/{spaceId}/pipelines/{pipelineName}/releasesList and inspect pipeline releases, start a release, or cancel an existing one.
- Pipeline state
/spaces/{spaceId}/pipelines/{pipelineName}/stateRead the current execution state of a pipeline or subscribe to state updates.
- Target runs
/spaces/{spaceId}/pipelines/{pipelineName}/releases/{releaseNumber}/runsList the target runs recorded for a release to track its progress.
- Tasks
/tasksThese endpoints require a task-specific access token issued by Munchii. The token must belong to the task identified in the URL. Standard session tokens are not accepted.