Restore folder - Box Dev Docs

cURL

curl -i -X POST "https://api.box.com/2.0/folders/4353455" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

{
  "id": "123456789",
  "etag": "1",
  "type": "folder",
  "sequence_id": "3",
  "name": "Contracts",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "description": "Legal contracts for the new ACME deal",
  "size": 629644,
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "id": "12345",
        "type": "folder",
        "etag": "1",
        "sequence_id": "3",
        "name": "Contracts"
      }
    ]
  },
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "trashed_at": null,
  "purged_at": null,
  "content_created_at": "2012-12-12T10:53:43-08:00",
  "content_modified_at": "2012-12-12T10:53:43-08:00",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "shared_link": null,
  "folder_upload_email": null,
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "item_status": "active"
}

POST

folders

{folder_id}

cURL

curl -i -X POST "https://api.box.com/2.0/folders/4353455" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

{
  "id": "123456789",
  "etag": "1",
  "type": "folder",
  "sequence_id": "3",
  "name": "Contracts",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "description": "Legal contracts for the new ACME deal",
  "size": 629644,
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "id": "12345",
        "type": "folder",
        "etag": "1",
        "sequence_id": "3",
        "name": "Contracts"
      }
    ]
  },
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "trashed_at": null,
  "purged_at": null,
  "content_created_at": "2012-12-12T10:53:43-08:00",
  "content_modified_at": "2012-12-12T10:53:43-08:00",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "shared_link": null,
  "folder_upload_email": null,
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "item_status": "active"
}

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

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

folder_id

string

required

The unique identifier that represent a folder.

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

The root folder of a Box account is always represented by the ID 0.

Query Parameters

fields

string[]

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.

Body

application/json

name

string

An optional new name for the folder.

Example:

"Restored Photos"

parent

object

Specifies an optional ID of a folder to restore the folder 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 folder to if the original location has been deleted.

Show child attributes

Response

Returns a folder object when the folder has been restored.

Represents a folder restored from the trash.

string

The unique identifier that represent a folder.

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

Example:

"123456789"

etag

string | null

The HTTP etag of this folder. This can be used within some API endpoints in the If-Match and If-None-Match headers to only perform changes on the folder if (no) changes have happened.

Example:

"1"

type

enum<string>

The value will always be folder.

Available options:

folder

Example:

"folder"

sequence_id

string | null

A numeric identifier that represents the most recent user event that has been applied to this item.

This can be used in combination with the GET /events-endpoint to filter out user events that would have occurred before this identifier was read.

An example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the sequence_id in the event is smaller than or equal to the sequence_id in the originally fetched resource.

Example:

"3"

name

string

The name of the folder.

Example:

"Contracts"

created_at

string<date-time> | null

The date and time when the folder was created. This value may be null for some folders such as the root folder or the trash folder.

Example:

"2012-12-12T10:53:43-08:00"

modified_at

string<date-time> | null

The date and time when the folder was last updated. This value may be null for some folders such as the root folder or the trash folder.

Example:

"2012-12-12T10:53:43-08:00"

description

string

The optional description of this folder.

Maximum string length: 256

Example:

"Legal contracts for the new ACME deal"

size

integer<int64>

The folder size in bytes.

Be careful parsing this integer as its value can get very large.

Example:

629644

path_collection

Path collection · object

The tree of folders that this file is contained in, starting at the root.

Show child attributes

created_by

User (Mini) · object

The user who created this folder.

Show child attributes

modified_by

User (Mini) · object

The user who last modified this folder.

Show child attributes

trashed_at

string | null

The time at which this folder was put in the trash - becomes null after restore.

Example:

null

purged_at

string | null

The time at which this folder is expected to be purged from the trash - becomes null after restore.

Example:

null

content_created_at

string<date-time> | null

The date and time at which this folder was originally created.

Example:

"2012-12-12T10:53:43-08:00"

content_modified_at

string<date-time> | null

The date and time at which this folder was last updated.

Example:

"2012-12-12T10:53:43-08:00"

owned_by

User (Mini) · object

The user who owns this folder.

Show child attributes

shared_link

string | null

The shared link for this file. This will be null if a folder had been trashed, even though the original shared link does become active again.

Example:

null

folder_upload_email

string | null

The folder upload email for this folder. This will be null if a folder has been trashed, even though the original upload email does become active again.

Example:

null

parent

Folder (Mini) · object

The optional folder that this folder is located within.

This value may be null for some folders such as the root folder or the trash folder.

Show child attributes

item_status

enum<string>

Defines if this item has been deleted or not.

active when the item has is not in the trash,
trashed when the item has been moved to the trash but not deleted,
deleted when the item has been permanently deleted.

Available options:

active,

trashed,

deleted

Example:

"active"

Permanently remove folder

List trashed items

⌘I