Skip to navigation

Agents Mutations List

Preview
View as Markdown

Lists retained filesystem mutations performed by the selected agent, newest first. The agent must belong to the authenticated user and Provider app. Pass next_cursor to continue. A move or rename shows the old and new locations in one mutation. When a folder is moved, renamed, or deleted, changes to its contents caused by that operation are not listed separately.

Required scope: private:agent_filesystem.agents.manage

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 mutations are listed, across all of its runtime tokens.
Variant:
agent_filesystem.AgentSelector.agent_idobjectRequired
Selects the agent by its Agent Filesystem ID.
cursorstring or nullOptional>=1 character
Continuation returned by the preceding call for the same agent.
limituint or nullOptional1-1000
Requested page size. Defaults to 100. Pages may exceed this size so that a move or folder operation is not split across pages.

Response headers

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

Response

Successful response
mutationslist of objects

Mutations in this page, with operation-specific metadata and timestamp_us, a Unix timestamp in microseconds. Precision can be as coarse as one second, so mutations in the same second may share a timestamp. Using it as restore_to_timestamp_us may undo the selected mutation as well as later writes.

next_cursorstring or nullOptional
Present when another page is available. Cursors expire after 24 hours.

Errors

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