Pipeline state

Read the current execution state of a pipeline or subscribe to state updates.

/spaces/{spaceId}/pipelines/{pipelineName}/state
  • GETGet a snapshot of the pipeline’s current execution state.

    Sample request

    GET /spaces/space_123/pipelines/web/state HTTP/1.1
    Host: api.munchii.com
    Authorization: Bearer <access-token>

    Example response

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
      "data": {
        "requiresAttention": false,
        "releases": [
          {
            "number": 42,
            "state": "pending",
            "started": false
          }
        ],
        "groups": [],
        "targets": [
          {
            "name": "deploy",
            "pendingReleases": [
              42
            ]
          }
        ]
      }
    }

    Common errors

    • 401 The credentials are missing, expired, or invalid.
    • 403 The caller lacks permission for this operation.
    • 404 The space or pipeline was not found.
/spaces/{spaceId}/pipelines/{pipelineName}/state/watch
  • GETStream pipeline state updates as server-sent events.

    Sample request

    GET /spaces/space_123/pipelines/web/state/watch?eventId=17 HTTP/1.1
    Host: api.munchii.com
    Authorization: Bearer <access-token>
    Accept: text/event-stream

    Example response

    HTTP/1.1 200 OK
    Content-Type: text/event-stream
    
    retry: 2000
    
    event: state
    data: {"eventId":18}
    
    

    Common errors

    • 401 The credentials are missing, expired, or invalid.
    • 403 The caller lacks permission for this operation.
    • 404 The space or pipeline was not found.