Restore progress and outcome

GET


          /api/v1/backups/restores/{restore}

Try it

R Read

Scope read:hosting

Description

Returns one restore's progress, phase and per-item failures, or the account's recent restores when no restore_id is given.

Path parameters

Name	Type	Description
`restore` required	string

Query parameters

Name	Type	Description
`input` required	string	A domain, email address, website URL, or Inleed service id — for example `example.se`, `[email protected]` or `42976`. Resolved to the owning account automatically, and the resolved `target` is echoed back in the response. Up to 255 characters.
`restore_id`	string	The restore to follow, from `restore_backup` → `restoreId` or from this tool's own `restores[].id`. Omit to list the account's recent restores.
`limit`	integer	Page size for a collection. Range 1–50.

Responses

The specification does not describe this response body; the note in the rail says what to expect. Every non-2xx response is an RFC 7807 problem with a stable code.

Commonly returned errors

The codes this operation reaches on its own path: the auth stack, its own validation and ownership checks, and the transport. Not a closed set — a shared code from the full registry can still surface. Each links to the code’s own page, the same URL its type dereferences to.

400

invalid_request

401 No token was presented, or the token is revoked, expired or unknown.

unauthorizedtoken_expiredtoken_revoked

403 The token lacks a required scope, or this account does not own the resource.

insufficient_scopedomain_not_owned

404 No such resource for this account.

not_found

422 Validation error

validation_failed

429 The rate limit for this token is exhausted. See `Retry-After`.

rate_limited

500 Something went wrong on our side. The failure is logged against `requestId`.

internal_error