Skip to main content
PUT
Restore entity records

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app that owns the entity.

entity_name
string
required

Name of the entity, exactly as List entity schemas reports it. Don't pass User here. It doesn't fail, but it reads and writes a separate, disconnected set of records stored under that name, not the app's real user accounts, which are managed through their own endpoints.

Body

application/json

Filter selecting the deleted records to restore, in the same form as q. Send {} to restore everything in the trash.

Response

How many records were restored.

How many deleted records were restored.

success
boolean
required

Always true. A restore that doesn't happen returns an error instead.

Example:

true

restored
integer
required

Number of records brought back. 0 when nothing in the trash matched the filter.

Example:

3