SandboxesSandbox TemplatesTemplate builds
Stop a template build
Stop a running build and hand its resources back. This returns at once: the build reads cancelling until the teardown finishes, and cancelled after it. Cancelling a build needs the same access as starting one.
Stop a running build and hand its resources back. This returns at once: the build reads cancelling until the teardown finishes, and cancelled after it. Cancelling a build needs the same access as starting one.
Authorization
apiKey AuthorizationBearer <token>
API key starting with tektona_. Create one at app-dev.tektona.ai under API Keys.
In: header
Path Parameters
buildId*string
Build ULID
Length
length <= 64Response Body
application/json
application/problem+json
curl -X PUT "https://example.com/v1/template-builds/string/cancel"{ "can_cancel": true, "cancelled_by": { "display_name": "string", "id": "string", "username": "string" }, "created_at": "2019-08-24T14:15:22Z", "error": "string", "finished_at": "2019-08-24T14:15:22Z", "id": "string", "image_ref": "string", "project": { "display_name": "Online Shop", "name": "online-shop" }, "resolved_digest": "string", "started_at": "2019-08-24T14:15:22Z", "status": "pending", "steps": [ { "attempt": 0, "context": { "user": "string", "workdir": "string" }, "exit_code": 0, "finished_at": "2019-08-24T14:15:22Z", "name": "string", "started_at": "2019-08-24T14:15:22Z", "status": "running", "step_index": 0, "tolerated": true, "type": "string" } ], "tags_on_success": [ "string" ], "template": { "deleted": true, "display_name": "Go Development", "id": "string", "name": "go-dev" }, "version_id": "string", "wait_reason": "string"}{ "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}