Runs

Cancel a run

Stop a run.

put/projects/{owner}/{name}/runs/{run_id}/cancel

Request

Base URL
https://api.pollination.solutions (the document declares no server; this is the origin it was published from)
Auth
- HTTP bearer
- or API key in header x-pollination-token
TypeScript
https://skmtc.dev/pollination/apis/pollination-server/docs/projects/:owner/:name/runs/:run_id/cancel/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

ownerstring required

namestring required

run_idstring required

Response

Accepted

idstring required

The unique ID for this run

generationnumber

The generation of this run

Example response

{
  "author": {
    "id": "0ad77f99-8043-46e4-8220-7221487c3ee5",
    "account_type": "user",
    "name": "ladybugbot",
    "display_name": "Ladybug Bot",
    "description": "Beep Boop!"
  },
  "owner": {
    "id": "0ad77f99-8043-46e4-8220-7221487c3ee5",
    "account_type": "user",
    "name": "ladybugbot",
    "display_name": "Ladybug Bot",
    "description": "Beep Boop!"
  },
  "recipe": {
    "inputs": [
      {
        "alias": [
          {
            "handler": [
              {
                "module": "honeybee_rhino.handlers"
              }
            ]
          }
        ]
      }
    ],
    "outputs": [
      {
        "alias": [
          {
            "handler": [
              {
                "module": "honeybee_rhino.handlers"
              }
            ]
          }
        ]
      }
    ]
  },
  "status": {
    "inputs": [
      {
        "alias": [
          {
            "handler": [
              {
                "module": "honeybee_rhino.handlers"
              }
            ]
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.