Skip to navigation

Agents Restore Writes

Preview
View as Markdown

Starts a human-authorized restore that reverses writes made by the selected agent after the requested time. Later changes made by other agents or users are preserved. Use the returned cursor to check the restore status.

Required scope: private:agent_filesystem.agents.restore

Endpoint format: RPC

Authentication: User

This endpoint does not support apps with the app folder permission.

Authentication

AuthorizationBearer

OAuth 2.0 token issued to a specific user. Use Authorization: Bearer <token>.

Public clients should use the authorization code flow with PKCE (S256).

For background or offline access, send token_access_type=offline during authorization and use the returned refresh token to obtain new access tokens.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

Headers

Dropbox-API-Select-UserstringOptional

Acts on behalf of a team member for supported user-auth operations. Pass a team member ID such as dbmid:.... When used with a team token, that token must also include the team_data.member scope.

Dropbox-API-Path-RootstringOptional

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the common.PathRoot union: {".tag": "home"}, {".tag": "root", "root": "<namespace_id>"}, or {".tag": "namespace_id", "namespace_id": "<namespace_id>"}. On failure the request returns 422 with a common.PathRootError.

Request

This endpoint expects an object.
agentobjectRequired
Agent whose writes are restored.
Variant:
agent_filesystem.AgentSelector.agent_idobjectRequired
Selects the agent by its Agent Filesystem ID.
restore_to_timestamp_uslongRequired>=1

Unix timestamp in microseconds to which the agent’s writes are restored. This may be a timestamp recorded before an agent run or derived from file metadata; a revision identifier is not required.

Response headers

X-Dropbox-Request-IdstringOptional
A unique identifier for the request, useful for debugging and support.

Response

Successful response
cursorstring1-8192 characters
Opaque cursor used to retrieve the restore's status, valid for 30 days.

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error