Runs

Stop a run.

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

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in header x-pollination-token

Path parameters

ownerstring required
namestring required
run_idstring required

Response

Accepted

idstring required

The unique ID for this run

generationnumber double

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

    • breaking

      response property detail/items/loc/items/ list-of-types was widened by adding types integer to media type application/json of response 422

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status