Skip to navigation
Modular DS Public APIBackupsRestorations

Retrieve a restoration

View as MarkdownOpen in Claude

Returns one restoration: how it is going, or why it failed. It carries the same information as “List restorations”.

Restorations are read only: nothing in this API starts, cancels or downloads one. The dashboard does.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Path parameters

siteRestorationstringRequired

Query parameters

includestringOptional

Relations to add to the answer, comma separated: site (the website) and backup (the backup the restoration came from).

Response

200 - Site restoration

dataobjectOptional
jsonapiobjectOptional