Skip to navigation
AgentFS APIAgent Filesystem

Agents Workspace Edit

Preview
View as Markdown

Adds, replaces, or removes explicit file or folder rules in an agent’s workspace. Rules for items not included in the request remain unchanged. Each referenced item must already exist and be visible to the authenticated user.

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 workspace is edited.
Variant:
agent_filesystem.AgentSelector.agent_idobjectRequired
Selects the agent by its Agent Filesystem ID.
entrieslist of objectsRequired
Edits to apply. Each entry adds, replaces, or removes the explicit rule for its file or folder. Rules for unmentioned items remain unchanged.

Response headers

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

Response

Successful response
entrieslist of objects
Explicit file and folder access rules assigned to the agent.

Errors

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