v4

latestSwagger 2.02026-08-0343714211.7 MB

restores

Restores

List Restores

get/restores

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are workspace_id.

If set, return records where the specified field is equal to the supplied value. Valid fields are restoration_type.

Response

A list of Restores objects.

earliest_datestring date-time

Restore all files deleted after this date/time. Don't set this earlier than you need. Can not be greater than 365 days prior to the restore request.

idinteger

Restore Record ID.

dirs_restoredinteger

Number of directories that were successfully restored.

dirs_erroredinteger

Number of directories that were not able to be restored.

dirs_totalinteger

Total number of directories processed.

files_restoredinteger

Number of files successfully restored.

files_erroredinteger

Number of files that were not able to be restored.

files_totalinteger

Total number of files processed.

prefixstring

Prefix of the files/folders to restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items, specify an empty string ('') in the prefix field or omit the field from the request.

restoration_type'files' | 'users'

Type of restoration to perform. files restores deleted filesystem items. users restores deleted users and associated access/authentication records.

restore_in_placeboolean

If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.

restore_deleted_permissionsboolean

If true, we will also restore any Permissions that match the same path prefix from the same dates.

users_restoredinteger

Number of users successfully restored (only present for restoration_type=users).

users_erroredinteger

Number of users that failed to restore (only present for restoration_type=users).

users_totalinteger

Total number of users processed (only present for restoration_type=users).

api_keys_restoredinteger

Number of API keys restored (only present for restoration_type=users).

public_keys_restoredinteger

Number of public keys restored (only present for restoration_type=users).

two_factor_authentication_methods_restoredinteger

Number of two factor authentication methods restored (only present for restoration_type=users).

status'pending' | 'counting' | 'restoring' | 'complete' | 'validating'

Status of the restoration process.

update_timestampsboolean

If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.

workspace_idinteger

Workspace ID for a workspace-scoped restore. 0 means the default site-wide scope.

error_messagesstring[]

Error messages received while restoring files and/or directories. Only present if there were errors.

Example response

[
  {
    "earliest_date": "2000-01-01T01:00:00Z",
    "id": 1,
    "dirs_restored": 1,
    "dirs_total": 1,
    "files_restored": 1,
    "files_total": 1,
    "prefix": "foo/bar/baz.txt",
    "restoration_type": "files",
    "restore_in_place": true,
    "restore_deleted_permissions": true,
    "users_restored": 1,
    "users_total": 1,
    "api_keys_restored": 1,
    "public_keys_restored": 1,
    "two_factor_authentication_methods_restored": 1,
    "status": "pending",
    "update_timestamps": true,
    "workspace_id": 12,
    "error_messages": [
      "example"
    ]
  }
]