getDeletionJob

Get a deletion job

Returns the current state of a deletion job, including the per-identifier dispositions. A job for an unknown or unowned job_id returns 404.

get/v2/jobs/{job_id}

Request

  • Base URL: https://example.ada.support/api
  • URL: https://example.ada.support/api/v2/jobs/{job_id}
  • Auth: none declared

Path parameters

job_idstring required

Identifier of the deletion job returned when the request was submitted.

Response

The deletion job was found.

job_idstring

Identifier of the deletion job.

typestring

The job type.

client_referencestring nullable

The caller-supplied reference from the original request, or null.

status'queued' | 'in_progress' | 'completed' | 'partial' | 'failed'

Lifecycle state of a deletion job. queued and in_progress are non-terminal; completed, partial, and failed are terminal.

created_atstring date-time

Time the job was created, in ISO 8601 format.

completed_atstring date-time nullable

Time the job reached a terminal state, in ISO 8601 format, or null while the job is still running.

failure_reasonstring nullable

Opaque, machine-readable diagnostic present only when status is failed, or null otherwise. This value is subject to change; to understand outcomes per identifier, inspect each identifier's disposition and reason.

Changes

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