jobs

Cancel a job

Stop a job.

  • A website action it already sent may have happened. Its write_status says whether it did.
  • Don't cancel a run whose maintenance.status is repairing. When its repair ends, Pomerado finishes the task, and a cancel ends the task without a result.
post/v1/jobs/{id}/cancel

Request

  • Base URL: https://api.pomerado.ai
  • URL: https://api.pomerado.ai/v1/jobs/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required
Example:job_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190

a job ID: job_ and 32 lowercase hex digits

Response

The job, stopping or cancelled

idstring required

a job ID: job_ and 32 lowercase hex digits

type'run' | 'build' required
status'queued' | 'running' | 'needs_input' | 'succeeded' | 'failed' | 'cancelled' required
tool_idstring nullable required
resultunknown required
result_previewunknown
result_status'available' | 'delivered' | 'expired' nullable required
result_expires_atstring required

a string to be decoded into a Date

write_status'not_attempted' | 'may_have_applied' | 'applied' | 'not_applied' nullable required
messagestring nullable required
site_urlstring nullable

The website's https origin the job was asked for: a build's site_url, or the site of the tool a run runs

site_namestring nullable

The site's name: its tool's integration's, else the integration of its website; null until one names it

taskstring nullable

A build's task, or a requested change, as it was sent; null for a run and a job accepted before Pomerado kept tasks

tool_namestring nullable

The name of the tool tool_id names, as GET /v1/tools shows it

waiting_sincestring nullable

When the question input_request asks was asked; null when the job asks none

watch_urlstring required
tipstring
created_atstring required

a string to be decoded into a Date

updated_atstring required

a string to be decoded into a Date

completed_atstring required

a string to be decoded into a Date

Example response

{
  "id": "job_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190",
  "input_request": {
    "id": "req_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"
  },
  "build": {
    "integration_id": "int_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"
  }
}

Changes

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