Skip to main content
POST
/
api
/
v1
/
vms
Initialise VM image upload
curl --request POST \
  --url https://api.example.com/api/v1/vms \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bucket_id": "<string>",
  "content_type": "<string>",
  "extra_attributes_json": "<string>",
  "filename": "<string>",
  "format": "<string>",
  "ram_mb": 123,
  "retention_period": 123,
  "size_bytes": 123,
  "vcpus": 123,
  "virt_type": "<string>"
}
'
{
  "expires_at": "<string>",
  "file_uuid": "<string>",
  "upload_url": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://gns3util.saygex.xyz/llms.txt

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

Authorizations

Authorization
string
header
required

Type "Bearer" followed by a space and JWT token.

Body

application/json

VM upload request

bucket_id
string
content_type
string
extra_attributes_json
string
filename
string
format
string
ram_mb
integer
retention_period
integer
size_bytes
integer
vcpus
integer
virt_type
string

Response

OK

expires_at
string
file_uuid
string
status
enum<string>
Available options:
pending,
uploading,
available,
tombstoned,
deleted
upload_url
string