---
title: "Cancel a run"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Workflows API

`POST /v1/organizations/{orgId}/projects/{projectId}/runs/{runId}/cancel`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `CancelRun.path.orgId` (string, required)
  - format `uuid`
- `CancelRun.path.projectId` (string, required)
  - format `uuid`
- `CancelRun.path.runId` (string, required)
  - format `uuid`

## Header parameters

- `CancelRun.header.Idempotency-Key` (string, optional) — Makes a retry safe: the same key and request get the stored response.
  - pattern `^[\x21-\x7e]{1,200}$`

## Request body

_Optional._

- `CancelRun.gracePeriodSeconds` (integer, optional)
  - min 0; max 3600; default `300`

## Example request

```json
{
  "gracePeriodSeconds": 300
}
```

## Code samples

### cURL

```curl
curl --request POST \
  --url https://workflows-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "gracePeriodSeconds": 300
}
'
```

### TypeScript

```typescript
const url = 'https://workflows-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({gracePeriodSeconds: 300})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://workflows-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"

payload = { "gracePeriodSeconds": 300 }
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

The run, cancelling.

#### Example

```json
{
  "appId": "28c365d5-df94-4a54-8217-3ce51d068868",
  "attempt": 0,
  "causeStepId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "endedAt": "2019-08-24T14:15:22Z",
  "error": {
    "cause": {
      "cause": {},
      "code": "string",
      "data": null,
      "message": "string",
      "name": "string",
      "stack": "string"
    },
    "code": "string",
    "data": null,
    "message": "string",
    "name": "string",
    "stack": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "parentRunId": "c21598d9-9e11-4929-a44f-027d54e71332",
  "runKey": "string",
  "scheduleId": "b7b4f318-018f-4d71-ac1a-f61e4bfaefbe",
  "scheduledTime": "2019-08-24T14:15:22Z",
  "status": "running",
  "steps": [
    {
      "attempt": 0,
      "error": {
        "cause": {
          "cause": {},
          "code": "string",
          "data": null,
          "message": "string",
          "name": "string",
          "stack": "string"
        },
        "code": "string",
        "data": null,
        "message": "string",
        "name": "string",
        "stack": "string"
      },
      "hasOutput": true,
      "kind": "run",
      "name": "string",
      "seq": 0,
      "status": "running",
      "stepId": "string"
    }
  ],
  "updatedAt": "2019-08-24T14:15:22Z",
  "workflow": "string"
}
```

- `CancelRun.response.200.appId` (string, required)
  - format `uuid`
- `CancelRun.response.200.attempt` (integer, required)
- `CancelRun.response.200.causeStepId` (string | null, required)
- `CancelRun.response.200.createdAt` (string, required)
  - format `date-time`
- `CancelRun.response.200.endedAt` (string | null, required)
  - format `date-time`
- `CancelRun.response.200.error` (object | null, required)
  - `CancelRun.response.200.error.code` (string, required) — user, or a workflows.* platform code.
  - `CancelRun.response.200.error.message` (string, required)
  - `CancelRun.response.200.error.name` (string, required)
  - `CancelRun.response.200.error.cause` (object | null, optional)
    - `CancelRun.response.200.error.cause.code` (string, required) — user, or a workflows.* platform code.
    - `CancelRun.response.200.error.cause.message` (string, required)
    - `CancelRun.response.200.error.cause.name` (string, required)
    - `CancelRun.response.200.error.cause.cause` (object | null, optional)
    - `CancelRun.response.200.error.cause.data` (unknown, optional) — The error's data, when the workflow attached any.
    - `CancelRun.response.200.error.cause.stack` (string, optional)
  - `CancelRun.response.200.error.data` (unknown, optional) — The error's data, when the workflow attached any.
  - `CancelRun.response.200.error.stack` (string, optional)
- `CancelRun.response.200.id` (string, required)
  - format `uuid`
- `CancelRun.response.200.parentRunId` (string | null, required) — A child workflow's run: the parent run that invoked it; null otherwise.
  - format `uuid`
- `CancelRun.response.200.runKey` (string | null, required)
- `CancelRun.response.200.scheduleId` (string | null, required) — The schedule that started the run (a firing or a manual trigger); null otherwise.
  - format `uuid`
- `CancelRun.response.200.scheduledTime` (string | null, required) — A schedule's run: the time it was scheduled for (a trigger's: when it was triggered); null otherwise.
  - format `date-time`
- `CancelRun.response.200.status` (string, required)
  - one of `"running"`, `"cancelling"`, `"completed"`, `"failed"`, `"cancelled"`, `"timedOut"`
- `CancelRun.response.200.steps` (array<object>, required)
  - `CancelRun.response.200.steps.attempt` (integer, required)
  - `CancelRun.response.200.steps.error` (object | null, required)
    - `CancelRun.response.200.steps.error.code` (string, required) — user, or a workflows.* platform code.
    - `CancelRun.response.200.steps.error.message` (string, required)
    - `CancelRun.response.200.steps.error.name` (string, required)
    - `CancelRun.response.200.steps.error.cause` (object | null, optional)
      - `CancelRun.response.200.steps.error.cause.code` (string, required) — user, or a workflows.* platform code.
      - `CancelRun.response.200.steps.error.cause.message` (string, required)
      - `CancelRun.response.200.steps.error.cause.name` (string, required)
      - `CancelRun.response.200.steps.error.cause.cause` (object | null, optional)
      - `CancelRun.response.200.steps.error.cause.data` (unknown, optional) — The error's data, when the workflow attached any.
      - `CancelRun.response.200.steps.error.cause.stack` (string, optional)
    - `CancelRun.response.200.steps.error.data` (unknown, optional) — The error's data, when the workflow attached any.
    - `CancelRun.response.200.steps.error.stack` (string, optional)
  - `CancelRun.response.200.steps.hasOutput` (boolean, required)
  - `CancelRun.response.200.steps.kind` (string, required) — run, sleep, value, callback (a callback's wait) or invoke (a child workflow).
    - one of `"run"`, `"sleep"`, `"value"`, `"callback"`, `"invoke"`
  - `CancelRun.response.200.steps.name` (string, required)
  - `CancelRun.response.200.steps.seq` (integer, required)
  - `CancelRun.response.200.steps.status` (string, required) — running, retrying, completed, failed, cancelled, sleeping, or waiting (a callback or child workflow not yet resolved).
    - one of `"running"`, `"retrying"`, `"completed"`, `"failed"`, `"cancelled"`, `"sleeping"`, `"waiting"`
  - `CancelRun.response.200.steps.stepId` (string, required)
- `CancelRun.response.200.updatedAt` (string, required)
  - format `date-time`
- `CancelRun.response.200.workflow` (string, required)

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CancelRun.response.400.error` (object, required)
  - `CancelRun.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CancelRun.response.400.error.message` (string, required)
    - maxLength 1024
  - `CancelRun.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CancelRun.response.400.error.issues.message` (string, required)
    - `CancelRun.response.400.error.issues.path` (string, required)
  - `CancelRun.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CancelRun.response.400.error.quota.id` (string, required)
    - `CancelRun.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CancelRun.response.400.error.quota.limit` (integer, required)
      - min 0
    - `CancelRun.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CancelRun.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `CancelRun.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CancelRun.response.400.error.quota.region` (string, optional)
    - `CancelRun.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CancelRun.response.400.error.quota.scopeResourceName` (string, optional)
    - `CancelRun.response.400.error.quota.used` (integer, optional)
      - min 0
    - `CancelRun.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CancelRun.response.401.error` (object, required)
  - `CancelRun.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CancelRun.response.401.error.message` (string, required)
    - maxLength 1024
  - `CancelRun.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CancelRun.response.401.error.issues.message` (string, required)
    - `CancelRun.response.401.error.issues.path` (string, required)
  - `CancelRun.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CancelRun.response.401.error.quota.id` (string, required)
    - `CancelRun.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CancelRun.response.401.error.quota.limit` (integer, required)
      - min 0
    - `CancelRun.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CancelRun.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `CancelRun.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CancelRun.response.401.error.quota.region` (string, optional)
    - `CancelRun.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CancelRun.response.401.error.quota.scopeResourceName` (string, optional)
    - `CancelRun.response.401.error.quota.used` (integer, optional)
      - min 0
    - `CancelRun.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CancelRun.response.403.error` (object, required)
  - `CancelRun.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CancelRun.response.403.error.message` (string, required)
    - maxLength 1024
  - `CancelRun.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CancelRun.response.403.error.issues.message` (string, required)
    - `CancelRun.response.403.error.issues.path` (string, required)
  - `CancelRun.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CancelRun.response.403.error.quota.id` (string, required)
    - `CancelRun.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CancelRun.response.403.error.quota.limit` (integer, required)
      - min 0
    - `CancelRun.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CancelRun.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `CancelRun.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CancelRun.response.403.error.quota.region` (string, optional)
    - `CancelRun.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CancelRun.response.403.error.quota.scopeResourceName` (string, optional)
    - `CancelRun.response.403.error.quota.used` (integer, optional)
      - min 0
    - `CancelRun.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CancelRun.response.404.error` (object, required)
  - `CancelRun.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CancelRun.response.404.error.message` (string, required)
    - maxLength 1024
  - `CancelRun.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CancelRun.response.404.error.issues.message` (string, required)
    - `CancelRun.response.404.error.issues.path` (string, required)
  - `CancelRun.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CancelRun.response.404.error.quota.id` (string, required)
    - `CancelRun.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CancelRun.response.404.error.quota.limit` (integer, required)
      - min 0
    - `CancelRun.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CancelRun.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `CancelRun.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CancelRun.response.404.error.quota.region` (string, optional)
    - `CancelRun.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CancelRun.response.404.error.quota.scopeResourceName` (string, optional)
    - `CancelRun.response.404.error.quota.used` (integer, optional)
      - min 0
    - `CancelRun.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 409

quota_exceeded (an allocation quota, with quota), idempotency_conflict, idempotency_in_progress (with Retry-After), organization_deletion_pending, operation_in_progress, or the endpoint's own 409 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CancelRun.response.409.error` (object, required)
  - `CancelRun.response.409.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CancelRun.response.409.error.message` (string, required)
    - maxLength 1024
  - `CancelRun.response.409.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CancelRun.response.409.error.issues.message` (string, required)
    - `CancelRun.response.409.error.issues.path` (string, required)
  - `CancelRun.response.409.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CancelRun.response.409.error.quota.id` (string, required)
    - `CancelRun.response.409.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CancelRun.response.409.error.quota.limit` (integer, required)
      - min 0
    - `CancelRun.response.409.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CancelRun.response.409.error.quota.inFlight` (integer, optional)
      - min 0
    - `CancelRun.response.409.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CancelRun.response.409.error.quota.region` (string, optional)
    - `CancelRun.response.409.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CancelRun.response.409.error.quota.scopeResourceName` (string, optional)
    - `CancelRun.response.409.error.quota.used` (integer, optional)
      - min 0
    - `CancelRun.response.409.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 413

payload_too_large: the body is over the endpoint's limit (1 MiB unless it says otherwise).

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CancelRun.response.413.error` (object, required)
  - `CancelRun.response.413.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CancelRun.response.413.error.message` (string, required)
    - maxLength 1024
  - `CancelRun.response.413.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CancelRun.response.413.error.issues.message` (string, required)
    - `CancelRun.response.413.error.issues.path` (string, required)
  - `CancelRun.response.413.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CancelRun.response.413.error.quota.id` (string, required)
    - `CancelRun.response.413.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CancelRun.response.413.error.quota.limit` (integer, required)
      - min 0
    - `CancelRun.response.413.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CancelRun.response.413.error.quota.inFlight` (integer, optional)
      - min 0
    - `CancelRun.response.413.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CancelRun.response.413.error.quota.region` (string, optional)
    - `CancelRun.response.413.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CancelRun.response.413.error.quota.scopeResourceName` (string, optional)
    - `CancelRun.response.413.error.quota.used` (integer, optional)
      - min 0
    - `CancelRun.response.413.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CancelRun.response.429.error` (object, required)
  - `CancelRun.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CancelRun.response.429.error.message` (string, required)
    - maxLength 1024
  - `CancelRun.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CancelRun.response.429.error.issues.message` (string, required)
    - `CancelRun.response.429.error.issues.path` (string, required)
  - `CancelRun.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CancelRun.response.429.error.quota.id` (string, required)
    - `CancelRun.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CancelRun.response.429.error.quota.limit` (integer, required)
      - min 0
    - `CancelRun.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CancelRun.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `CancelRun.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CancelRun.response.429.error.quota.region` (string, optional)
    - `CancelRun.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CancelRun.response.429.error.quota.scopeResourceName` (string, optional)
    - `CancelRun.response.429.error.quota.used` (integer, optional)
      - min 0
    - `CancelRun.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CancelRun.response.500.error` (object, required)
  - `CancelRun.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CancelRun.response.500.error.message` (string, required)
    - maxLength 1024
  - `CancelRun.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CancelRun.response.500.error.issues.message` (string, required)
    - `CancelRun.response.500.error.issues.path` (string, required)
  - `CancelRun.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CancelRun.response.500.error.quota.id` (string, required)
    - `CancelRun.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CancelRun.response.500.error.quota.limit` (integer, required)
      - min 0
    - `CancelRun.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CancelRun.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `CancelRun.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CancelRun.response.500.error.quota.region` (string, optional)
    - `CancelRun.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CancelRun.response.500.error.quota.scopeResourceName` (string, optional)
    - `CancelRun.response.500.error.quota.used` (integer, optional)
      - min 0
    - `CancelRun.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CancelRun.response.503.error` (object, required)
  - `CancelRun.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CancelRun.response.503.error.message` (string, required)
    - maxLength 1024
  - `CancelRun.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CancelRun.response.503.error.issues.message` (string, required)
    - `CancelRun.response.503.error.issues.path` (string, required)
  - `CancelRun.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CancelRun.response.503.error.quota.id` (string, required)
    - `CancelRun.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CancelRun.response.503.error.quota.limit` (integer, required)
      - min 0
    - `CancelRun.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CancelRun.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `CancelRun.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CancelRun.response.503.error.quota.region` (string, optional)
    - `CancelRun.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CancelRun.response.503.error.quota.scopeResourceName` (string, optional)
    - `CancelRun.response.503.error.quota.used` (integer, optional)
      - min 0
    - `CancelRun.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/workflows-api/CancelRun/index.md