Box Developer Documentation
 
    Latest version

    Restore file

    post
    https://api.box.com/2.0
    /files/:file_id

    This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

    Restores a file that has been moved to the trash.

    An optional new parent ID can be provided to restore the file to in case the original folder has been deleted.

    Request

    bearer [ACCESS_TOKEN]
    application/json

    Path Parameters

    stringin pathrequired
    12345

    The unique identifier that represents a file.

    The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

    Query Parameters

    string arrayin queryoptional
    id,type,name

    A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

    Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

    Request Body

    stringin bodyoptional
    "Restored.docx"

    An optional new name for the file.

    objectin body

    Specifies an optional ID of a folder to restore the file to when the original folder no longer exists.

    Please be aware that this ID will only be used if the original folder no longer exists. Use this ID to provide a fallback location to restore the file to if the original location has been deleted.

    stringin bodyoptional
    "123"

    The ID of parent item

    Response

    Returns a file object when the file has been restored.

    application/jsonClient error

    Returns an error if the user does not have access to the folder the file is being restored to, or the user does not have permission to restore files from the trash.

    application/jsonClient error

    Returns an error if the file is not in the trash.

    application/jsonClient error

    Returns an error if there is an file with the same name in the folder the file is being restored to.

    application/jsonClient error

    An unexpected client error.

    post
    Restore file
    You can now try out some of our APIs live, right here in the documentation.
    Log in

    Request Example

    Response Example

    {
      "id": "123456789",
      "type": "file",
      "content_created_at": "2012-12-12T10:53:43-08:00",
      "content_modified_at": "2012-12-12T10:53:43-08:00",
      "created_at": "2012-12-12T10:53:43-08:00",
      "created_by": {
        "id": "11446498",
        "type": "user",
        "login": "ceo@example.com",
        "name": "Aaron Levie"
      },
      "description": "Contract for Q1 renewal",
      "etag": "1",
      "file_version": {
        "id": "12345",
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      },
      "item_status": "active",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "modified_by": {
        "id": "11446498",
        "type": "user",
        "login": "ceo@example.com",
        "name": "Aaron Levie"
      },
      "name": "Contract.pdf",
      "owned_by": {
        "id": "11446498",
        "type": "user",
        "login": "ceo@example.com",
        "name": "Aaron Levie"
      },
      "parent": {
        "id": "12345",
        "type": "folder",
        "etag": "1",
        "name": "Contracts",
        "sequence_id": "3"
      },
      "path_collection": {
        "entries": [
          {
            "etag": "1",
            "id": "12345",
            "type": "folder",
            "name": "Contracts",
            "sequence_id": "3"
          }
        ],
        "total_count": 1
      },
      "purged_at": "null",
      "sequence_id": "3",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "shared_link": "null",
      "size": 629644,
      "trashed_at": "null"
    }