POST
/
v1
/
projects
/
{project}
/
boxes
/
{name}
/
snapshots
Create a snapshot of a box
curl --request POST \
  --url https://api.example.com/v1/projects/{project}/boxes/{name}/snapshots \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "name": "<string>"
}
'
{
  "created_at": "<string>",
  "name": "<string>",
  "size_bytes": 1,
  "description": "<string>"
}

Path Parameters

​
project
string
required

Project name

​
name
string
required

Box name

Body

application/json
​
description
string | null
​
name
string | null

Response

Snapshot created

​
created_at
string
required
​
name
string
required
​
size_bytes
integer<int64>
required
Required range: x >= 0
​
description
string | null