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

Path Parameters

​
file_uuid
string
required

File UUID

Body

application/json

Update request

​
compression
string
​
include_images
boolean
​
include_snapshots
boolean
​
is_read_only
boolean
​
keep_compute_ids
boolean
​
project_name
string
​
reset_mac_addresses
boolean
​
version_tag
string

Response

OK

​
blob_sha256
string
​
bucket_id
string
​
compression
string
​
content_type
string
​
created_at
string
​
file_uuid
string
​
filename
string
​
include_images
boolean
​
include_snapshots
boolean
​
is_read_only
boolean
​
keep_compute_ids
boolean
​
owner_id
string
​
project_id
string
​
project_name
string
​
reset_mac_addresses
boolean
​
size_bytes
integer
​
status
enum<string>
Available options:
pending,
uploading,
available,
tombstoned,
deleted
​
updated_at
string
​
version_tag
string