Jobs

Get a background job's status

Poll a job started by a 202 response (a large changeset, a large site rename, or a URL import) until status is succeeded or failed. progress and result depend on the job's kind. A job id only works on the site it was started for.

get/api/v1/sites/{slug}/jobs/{id}

Request

  • Base URL: https://api.dotsy.ai
  • URL: https://api.dotsy.ai/api/v1/sites/{slug}/jobs/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

slugstring required
Example:acme-studio

Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.

idstring required
Example:content.0c9e2f4a-1b2c-4d5e-8f90-a1b2c3d4e5f6.Qm9vdHN0cmFwSm9iSWRTaWc

The job.id from the 202 response that started the job.

Response

The job.

idstring required

Public job id. Poll GET /api/v1/sites/{slug}/jobs/{id}.

kind'import' | 'content' | 'rename' required
status'queued' | 'running' | 'succeeded' | 'failed' required
resultobject

Changes

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