Latest version

Create archive

post

https://api.box.com/2.0

/archives

Creates an archive.

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Request Headers

box-version stringin headerrequired

Version header.

Value is always 2025.0

Request Body

name stringin bodyrequired

example"Some Archive"

The name of the archive.

Response

201application/jsonArchive

Returns a new archive object.

400application/jsonClient error

Returns an error if some of the parameters are missing or not valid.

401application/jsonClient error

Returned when the access token provided in the Authorization header is not recognized or not provided.

403application/jsonClient error

Returns an error if the authenticated user does not have the right permissions to create an archive.

409application/jsonClient error

Returns an error if an archive with the given name already exists.

500application/jsonClient error

An unexpected server error.

defaultapplication/jsonClient error

An unexpected client error.

post

Create archive

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

Request Example

curl -i -X POST "https://api.box.com/2.0/archives" \
     -H "box-version: 2025.0" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "name": "Some Archive Name"
     }'

await client.archives.createArchiveV2025R0({
  name: archiveName,
} satisfies CreateArchiveV2025R0RequestBody);

client.archives.create_archive_v2025_r0(archive_name)

await client.Archives.CreateArchiveV2025R0Async(requestBody: new CreateArchiveV2025R0RequestBody(name: archiveName));

Swift Gen (Beta)

try await client.archives.createArchiveV2025R0(requestBody: CreateArchiveV2025R0RequestBody(name: archiveName))

Java Gen (Beta)

client.getArchives().createArchiveV2025R0(new CreateArchiveV2025R0RequestBody(archiveName))

Response Example

{
  "id": "12345",
  "type": "archive",
  "name": "Archive",
  "size": 123456789
}