Pipelines

Manage release pipelines within a space and enable or disable execution.

/spaces/{spaceId}/pipelines
  • GETList pipelines in the space.

    Sample request

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

    Example response

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
      "data": [
        {
          "id": "pipeline_123",
          "name": "web",
          "requiresAttention": false
        }
      ]
    }

    Common errors

    • 401 The credentials are missing, expired, or invalid.
    • 403 The caller lacks permission for this operation.
    • 404 The space was not found.
/spaces/{spaceId}/pipelines/{pipelineName}
  • GETGet the pipeline’s details and settings.

    Sample request

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

    Example response

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
      "self": {
        "id": "pipeline_123",
        "name": "web"
      },
      "data": {
        "execution": {
          "runMode": "auto"
        }
      }
    }

    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.
  • PUTCreate a pipeline with the specified name.

    Sample request

    PUT /spaces/space_123/pipelines/web HTTP/1.1
    Host: api.munchii.com
    Authorization: Bearer <access-token>
    Content-Type: application/json
    
    {}

    Example response

    HTTP/1.1 201 Created

    Empty response body.

    Common errors

    • 400 Use application/json and send valid JSON that matches the expected schema.
    • 401 The credentials are missing, expired, or invalid.
    • 403 The caller lacks permission for this operation.
    • 404 The space was not found.
  • PATCHRename the pipeline, change its execution mode, or do both in one request.

    Sample request

    PATCH /spaces/space_123/pipelines/web HTTP/1.1
    Host: api.munchii.com
    Authorization: Bearer <access-token>
    Content-Type: application/json
    
    {
      "execution": {
        "runMode": "step"
      }
    }

    Example response

    HTTP/1.1 204 No Content

    Empty response body.

    Common errors

    • 400 Provide a valid pipeline name or execution mode.
    • 401 The credentials are missing, expired, or invalid.
    • 403 The caller lacks permission for this operation.
    • 404 The space or pipeline was not found.
  • DELETEDelete the pipeline.

    Sample request

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

    Example response

    HTTP/1.1 204 No Content

    Empty response body.

    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.
    • 409 The pipeline must be empty before it can be deleted.
/spaces/{spaceId}/pipelines/{pipelineName}/enable
  • POSTEnable pipeline execution.

    Sample request

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

    Example response

    HTTP/1.1 204 No Content

    Empty response body.

    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}/disable
  • POSTDisable pipeline execution.

    Sample request

    POST /spaces/space_123/pipelines/web/disable HTTP/1.1
    Host: api.munchii.com
    Authorization: Bearer <access-token>
    Content-Type: application/json
    
    {
      "reason": "Maintenance"
    }

    Example response

    HTTP/1.1 204 No Content

    Empty response body.

    Common errors

    • 400 Use application/json and send valid JSON that matches the expected schema.
    • 401 The credentials are missing, expired, or invalid.
    • 403 The caller lacks permission for this operation.
    • 404 The space or pipeline was not found.