Skip to main content
POST
/
api
/
v1
/
images
/
create
cURL
curl --request POST \
  --url https://api.example.com/api/v1/images/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "image_name": "<string>",
  "source": {
    "image_ref": "<string>",
    "type": "docker"
  },
  "description": "<string>",
  "size_mib": 123
}
'
{
  "image_name": "<string>",
  "job_id": "<string>",
  "status": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vers.sh/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
image_name
string
required
source
object
required
description
string | null
size_mib
integer<int32>

Additional capacity in MiB beyond the actual filesystem size (defaults to 256). The final image size = calculated rootfs size + this value. Set to 0 for minimum possible image size, or higher for more free space.

Response

Image creation job started

image_name
string
required
job_id
string
required
status
string
required