Skip to content
Ibby docs
Esc
↑↓navigate↵open⌘Jpreview

Cancel a job

Asks the job to stop. A job that has already finished is returned as it is.

POST/v1/jobs/{id}/cancel
Authorization
AuthorizationBearer token (ibk_<public id>_<secret>) · headerrequired

A lane's API key. The lane is taken from the key, never from the request.

Path parameters
idstringrequired

A job id: job_ and a random part, at most 64 characters.

max length 64 · matches ^job_[0-9A-Za-z]+$
Responses
200

The job.

created_atstring<date-time>required

A UTC time in RFC 3339 form.

errorJobError | nullrequired

Set when status is failed.

Show properties
Any of:
JobError
codestringrequired

A stable code for why the job failed. New codes may be added, so treat an unknown one as a failure. Known codes for kind image_build: build_failed (The build itself failed, for example a package would not install.), build_lost (The platform lost track of the build. Build the recipe again.), import_check_failed (The image built, but a module in import_check would not import.), unavailable (A service behind the API failed. Build the recipe again after a short wait.).

messagestringrequired
null
null
idstringrequired

The job id, job_....

kindstringrequired

What the job does. Each kind documents its own result.

resultobject | nullrequired

Set when status is done. Its shape depends on kind.

Show properties
Any of:
object
object
null
null
statusJobStatusrequired

Moves forward only. done, failed and cancelled are final.

Allowed:acceptedrunningdonefailedcancelled
updated_atstring<date-time>required

A UTC time in RFC 3339 form.

400

invalid_request: The request does not match the contract.

errorErrorDetailrequired
Show properties
codestringrequired

A stable, machine-readable code. Known codes: env_name_refused, file_not_found, file_too_large, idempotency_mismatch, image_not_built, in_progress, internal_error, invalid_request, lane_limit, name_in_use, not_found, payload_too_large, resources_over_cap, region_mismatch, sandbox_stopped, unavailable, store_prefix_refused, store_unavailable, unauthorized. New codes may be added, so treat an unknown one by its HTTP status.

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

401

unauthorized: The API key is missing, unknown or revoked.

errorErrorDetailrequired
Show properties
codestringrequired

A stable, machine-readable code. Known codes: env_name_refused, file_not_found, file_too_large, idempotency_mismatch, image_not_built, in_progress, internal_error, invalid_request, lane_limit, name_in_use, not_found, payload_too_large, resources_over_cap, region_mismatch, sandbox_stopped, unavailable, store_prefix_refused, store_unavailable, unauthorized. New codes may be added, so treat an unknown one by its HTTP status.

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

404

not_found: No such resource in this key's lane. Another lane's ids are not found either.

errorErrorDetailrequired
Show properties
codestringrequired

A stable, machine-readable code. Known codes: env_name_refused, file_not_found, file_too_large, idempotency_mismatch, image_not_built, in_progress, internal_error, invalid_request, lane_limit, name_in_use, not_found, payload_too_large, resources_over_cap, region_mismatch, sandbox_stopped, unavailable, store_prefix_refused, store_unavailable, unauthorized. New codes may be added, so treat an unknown one by its HTTP status.

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

500

internal_error: The platform failed. A retry may succeed; for a call that creates or writes, retry with the same Idempotency-Key.

errorErrorDetailrequired
Show properties
codestringrequired

A stable, machine-readable code. Known codes: env_name_refused, file_not_found, file_too_large, idempotency_mismatch, image_not_built, in_progress, internal_error, invalid_request, lane_limit, name_in_use, not_found, payload_too_large, resources_over_cap, region_mismatch, sandbox_stopped, unavailable, store_prefix_refused, store_unavailable, unauthorized. New codes may be added, so treat an unknown one by its HTTP status.

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

503

unavailable: A service behind the API could not be reached. Retry after a short wait; for a call that creates or writes, with the same Idempotency-Key.

errorErrorDetailrequired
Show properties
codestringrequired

A stable, machine-readable code. Known codes: env_name_refused, file_not_found, file_too_large, idempotency_mismatch, image_not_built, in_progress, internal_error, invalid_request, lane_limit, name_in_use, not_found, payload_too_large, resources_over_cap, region_mismatch, sandbox_stopped, unavailable, store_prefix_refused, store_unavailable, unauthorized. New codes may be added, so treat an unknown one by its HTTP status.

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

Request
curl -X POST 'https://api.ibby.ai/v1/jobs/job_7Hc2mQ/cancel' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "created_at": "2019-08-24T14:15:22Z",
  "error": {
    "code": "build_failed",
    "message": "string"
  },
  "id": "job_9xQ1",
  "kind": "image_build",
  "result": {},
  "status": "accepted",
  "updated_at": "2019-08-24T14:15:22Z"
}

Was this page helpful?