Dropbox: Restore a specific revision of a file to the given path

Dropbox files.restore: arguments, response, policy and SDK examples.

Operation dropbox.files_restore

Provider route: POST /2/files/restore. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/dropbox with npm, or alter-sdk-dropbox with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DropboxIntegration } from "@alter-ai/dropbox";

async function execute(input: Parameters<DropboxIntegration["files"]["restore"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new DropboxIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.files.restore(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_dropbox import DropboxIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = DropboxIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.files.restore(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`headers`	object	Optional	Additional keys: not allowed
`headers.Dropbox-API-Path-Root`	Model	Optional	Expand Deletes a group — request body — headers Dropbox-API-Path-Root
`headers.Dropbox-API-Select-User`	string	Optional
`headers.Dropbox-API-Select-Admin`	string	Optional
`body`	Model	Required within parent	Expand Restore a specific revision of a file to the given path — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Restore a specific revision of a file to the given path — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Restore a specific revision of a file to the given path — response body

Referenced models: Restore a specific revision of a file to the given path — response body

Schemas

5 more schemas are linked from the tables above, on the schema pages.

Deletes a group — request body — headers Dropbox-API-Path-Root

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	string	Alternative	One of: home
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: home
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: root
`$ (anyOf 3).root`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: namespace_id
`$ (anyOf 4).namespace_id`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`$ (anyOf 5)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 5)..tag`	string	Required within parent	Pattern: ^(?!(?:home\|root\|namespace_id)$)

Restore a specific revision of a file to the given path — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`path`	string	Required within parent	Pattern: ^(?:(/(.\|[\r\n]))\|(ns:[0-9]+(/(.\|[\r\n]))?))$
`rev`	string	Required within parent	Minimum length: 9 Pattern: ^(?:[0-9a-f]+)$

Restore a specific revision of a file to the given path — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`name`	string	Required within parent
`path_lower`	JSON	Optional
`path_lower (anyOf 1)`	string	Alternative
`path_lower (anyOf 2)`	null	Alternative
`path_display`	JSON	Optional
`path_display (anyOf 1)`	string	Alternative
`path_display (anyOf 2)`	null	Alternative
`parent_shared_folder_id`	JSON	Optional
`parent_shared_folder_id (anyOf 1)`	string	Alternative	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`parent_shared_folder_id (anyOf 2)`	null	Alternative
`preview_url`	JSON	Optional
`preview_url (anyOf 1)`	string	Alternative
`preview_url (anyOf 2)`	null	Alternative
`id`	string	Required within parent	Minimum length: 1
`client_modified`	string	Required within parent
`server_modified`	string	Required within parent
`rev`	string	Required within parent	Minimum length: 9 Pattern: ^(?:[0-9a-f]+)$
`size`	JSON	Required within parent
`size (anyOf 1)`	integer	Alternative	Minimum: 0
`size (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`media_info`	JSON	Optional
`media_info (anyOf 1)`	Model	Alternative	Expand Restore a specific revision of a file to the given path — response body — media info value
`media_info (anyOf 2)`	null	Alternative
`symlink_info`	JSON	Optional
`symlink_info (anyOf 1)`	Model	Alternative	Expand Restore a specific revision of a file to the given path — response body — symlink info target
`symlink_info (anyOf 2)`	null	Alternative
`sharing_info`	JSON	Optional
`sharing_info (anyOf 1)`	Model	Alternative	Expand Restore a specific revision of a file to the given path — response body — sharing info modified by, parent shared folder id, read only
`sharing_info (anyOf 2)`	null	Alternative
`is_downloadable`	boolean	Optional
`export_info`	JSON	Optional
`export_info (anyOf 1)`	Model	Alternative	Expand Restore a specific revision of a file to the given path — response body — export info Export information for a file
`export_info (anyOf 2)`	null	Alternative
`property_groups`	JSON	Optional
`property_groups (anyOf 1)`	array	Alternative
`property_groups (anyOf 1)[]`	Model	Each item	Expand Add property groups to a Dropbox file — request body — body property groups item
`property_groups (anyOf 2)`	null	Alternative
`has_explicit_shared_members`	JSON	Optional
`has_explicit_shared_members (anyOf 1)`	boolean	Alternative
`has_explicit_shared_members (anyOf 2)`	null	Alternative
`content_hash`	JSON	Optional
`content_hash (anyOf 1)`	string	Alternative	Maximum length: 64 Minimum length: 64
`content_hash (anyOf 2)`	null	Alternative
`file_lock_info`	JSON	Optional
`file_lock_info (anyOf 1)`	Model	Alternative	Expand Restore a specific revision of a file to the given path — response body — file lock info created, is lockholder, lockholder account id, lockholder name
`file_lock_info (anyOf 2)`	null	Alternative
`is_restorable`	JSON	Optional
`is_restorable (anyOf 1)`	boolean	Alternative
`is_restorable (anyOf 2)`	null	Alternative

Referenced models: Add property groups to a Dropbox file — request body — body property groups item, Restore a specific revision of a file to the given path — response body — export info Export information for a file, Restore a specific revision of a file to the given path — response body — file lock info created, is lockholder, lockholder account id, lockholder name, Restore a specific revision of a file to the given path — response body — sharing info modified by, parent shared folder id, read only, Restore a specific revision of a file to the given path — response body — symlink info target, Restore a specific revision of a file to the given path — response body — media info value

Add property groups to a Dropbox file — request body — body property groups item

Field	Type	Presence	Description and constraints
`$`	object	Root	A subset of the property fields described by the corresponding PropertyGroupTemplate. Properties are always added to a Dropbox file as a PropertyGroup. The possible key names and value types in this group are defined by the corresponding PropertyGroupTemplate.
`template_id`	string	Required within parent	Minimum length: 1 Pattern: ^(?:(/\|ptid:).*)$
`fields`	array	Required within parent
`fields[]`	Model	Each item	Expand Add property groups to a Dropbox file — request body — body property groups item fields item

Referenced models: Add property groups to a Dropbox file — request body — body property groups item fields item

Restore a specific revision of a file to the given path — response body — export info Export information for a file

Field	Type	Presence	Description and constraints
`$`	object	Root	Export information for a file.
`export_as`	JSON	Optional
`export_as (anyOf 1)`	string	Alternative
`export_as (anyOf 2)`	null	Alternative
`export_options`	JSON	Optional
`export_options (anyOf 1)`	array	Alternative
`export_options (anyOf 1)[]`	string	Each item
`export_options (anyOf 2)`	null	Alternative

Restore a specific revision of a file to the given path — response body — file lock info created, is lockholder, lockholder account id, lockholder name

Field	Type	Presence	Description and constraints
`$`	object	Root
`is_lockholder`	JSON	Optional
`is_lockholder (anyOf 1)`	boolean	Alternative
`is_lockholder (anyOf 2)`	null	Alternative
`lockholder_name`	JSON	Optional
`lockholder_name (anyOf 1)`	string	Alternative
`lockholder_name (anyOf 2)`	null	Alternative
`lockholder_account_id`	JSON	Optional
`lockholder_account_id (anyOf 1)`	string	Alternative	Maximum length: 40 Minimum length: 40
`lockholder_account_id (anyOf 2)`	null	Alternative
`created`	JSON	Optional
`created (anyOf 1)`	string	Alternative
`created (anyOf 2)`	null	Alternative

Restore a specific revision of a file to the given path — response body — sharing info modified by, parent shared folder id, read only

Field	Type	Presence	Description and constraints
`$`	object	Root	Sharing info for a file which is contained by a shared folder.
`read_only`	boolean	Required within parent
`parent_shared_folder_id`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`modified_by`	JSON	Optional
`modified_by (anyOf 1)`	string	Alternative	Maximum length: 40 Minimum length: 40
`modified_by (anyOf 2)`	null	Alternative

Restore a specific revision of a file to the given path — response body — symlink info target

Field	Type	Presence	Description and constraints
`$`	object	Root
`target`	string	Required within parent

Policy, approvals and errors

SDK function policy ID: dropbox.files_restore. Catalog operation: files/restore. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["files.content.write"]

Official provider source

Report an issue with this page