Skip to main content
POST
/
api
/
v1
/
project-files
Initialise project file upload
curl --request POST \
  --url https://api.example.com/api/v1/project-files \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bucket_id": "<string>",
  "compression": "<string>",
  "content_type": "<string>",
  "filename": "<string>",
  "include_images": true,
  "include_snapshots": true,
  "is_read_only": true,
  "keep_compute_ids": true,
  "project_id": "<string>",
  "project_name": "<string>",
  "reset_mac_addresses": true,
  "retention_period": 123,
  "size_bytes": 123,
  "version_tag": "<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

Project file upload request

bucket_id
string
compression
string

deflate|bz2|xz|zstd|none

content_type
string
filename
string
include_images
boolean
include_snapshots
boolean
is_read_only
boolean
keep_compute_ids
boolean
project_id
string
project_name
string
reset_mac_addresses
boolean
retention_period
integer
size_bytes
integer
version_tag
string

Response

OK

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