Latest version
Create archive
API version 2025.0
Creates an archive.
To learn more about the archive APIs, see the Archive API Guide.
Request
bearer [ACCESS_TOKEN]
application/json
Request Headers
stringin headerrequired
Version header.
Value is always 2025.0
Request Body
stringin bodyrequired
"Some Archive"The name of the archive.
Response
application/jsonArchive
Returns a new archive object.
application/jsonClient error
Returns an error if some of the parameters are missing or not valid.
application/jsonClient error
Returned when the access token provided in the Authorization header
is not recognized or not provided.
application/jsonClient error
Returns an error if the authenticated user does not have the right permissions to create an archive.
application/jsonClient error
Returns an error if an archive with the given name already exists.
application/jsonClient error
An unexpected server error.
application/jsonClient error
An unexpected client error.
Request Example
cURL
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"
}'Node/TypeScript v10
await client.archives.createArchiveV2025R0({
name: archiveName,
} satisfies CreateArchiveV2025R0RequestBody);Python v10
client.archives.create_archive_v2025_r0(archive_name).NET v10
await client.Archives.CreateArchiveV2025R0Async(requestBody: new CreateArchiveV2025R0RequestBody(name: archiveName));Swift v10
try await client.archives.createArchiveV2025R0(requestBody: CreateArchiveV2025R0RequestBody(name: archiveName))Java v10
client.getArchives().createArchiveV2025R0(new CreateArchiveV2025R0RequestBody(archiveName))Response Example
{
"id": "12345",
"type": "archive",
"name": "Archive",
"size": 123456789
}