org.tangled.ci.cancelPipeline Documentation (EN)

main procedure

Cancel running pipeline or specific workflows

Input

Encodingapplication/json

pipeline string Required

Spindle-local pipeline id

repo stringdid Required

git repository DID

workflows array Optional

Workflow names to filter. When not provided, entire pipeline will be canceled.

Errors

InvalidRequest Invalid request parameters

RepoNotFound Repository not found

PipelineNotFound Pipeline not found in this repository

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "description": "Cancel running pipeline or specific workflows",
  "errors": [
    {
      "description": "Invalid request parameters",
      "name": "InvalidRequest"
    },
    {
      "description": "Repository not found",
      "name": "RepoNotFound"
    },
    {
      "description": "Pipeline not found in this repository",
      "name": "PipelineNotFound"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "pipeline": {
          "description": "Spindle-local pipeline id",
          "type": "string"
        },
        "repo": {
          "description": "git repository DID",
          "format": "did",
          "type": "string"
        },
        "workflows": {
          "description": "Workflow names to filter. When not provided, entire pipeline will be canceled.",
          "items": {
            "description": "workflow name",
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "repo",
        "pipeline"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}