Sign in

v1

latestOpenAPI 3.0.12026-07-269427.8 KB

Get update status

Get the status of an update from the status ID

Authenticate with an admin API key.

get/project/update-status/{statusId}

Path parameters

statusIdstring required

The status ID of a triggered update.

Response

A successful response

_idstring

The status ID of the triggered updated.

projectIdstring

The documentation project ID.

createdAtstring

An ISODate with the specified datetime in UTC

endedAtstring

An ISODate with the specified datetime in UTC

status'queued' | 'in_progress' | 'success' | 'failure'

The status of the update.

summarystring

Summary of the status of the update

logsstring[]

An array of logs.

subdomainstring

The subdomain of the docs being updated.

screenshotstring

A screenshot of the docs.

screenshotLightstring

A screenshot of the docs.

screenshotDarkstring

A screenshot of the docs in dark mode.

source'internal' | 'github-app-installation' | 'api' | 'github' | 'dashboard' | 'gitlab' | 'onboarding'

The source of the update trigger.