# org.tangled.ci.cancelPipeline

> Published by [tangled.org](https://lexicon.garden/identity/did:plc:wshs7t2adsemcrrd4snkeqli)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.ci.cancelPipeline)
- [Documentation](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.ci.cancelPipeline/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.ci.cancelPipeline/examples)

## Definitions

### `org.tangled.ci.cancelPipeline`

**Type**: `procedure`

Cancel running pipeline or specific workflows

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `pipeline` | `string` | Yes | Spindle-local pipeline id |
| `repo` | `string` (did) | Yes | git repository DID |
| `workflows` | `array` | No | 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

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "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"
    }
  },
  "id": "org.tangled.ci.cancelPipeline",
  "lexicon": 1
}
```