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>"
}
'import requests
url = "https://api.example.com/api/v1/project-files"
payload = {
"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>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://api.example.com/api/v1/project-files', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/project-files",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/project-files"
payload := strings.NewReader("{\n \"bucket_id\": \"<string>\",\n \"compression\": \"<string>\",\n \"content_type\": \"<string>\",\n \"filename\": \"<string>\",\n \"include_images\": true,\n \"include_snapshots\": true,\n \"is_read_only\": true,\n \"keep_compute_ids\": true,\n \"project_id\": \"<string>\",\n \"project_name\": \"<string>\",\n \"reset_mac_addresses\": true,\n \"retention_period\": 123,\n \"size_bytes\": 123,\n \"version_tag\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/project-files")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"bucket_id\": \"<string>\",\n \"compression\": \"<string>\",\n \"content_type\": \"<string>\",\n \"filename\": \"<string>\",\n \"include_images\": true,\n \"include_snapshots\": true,\n \"is_read_only\": true,\n \"keep_compute_ids\": true,\n \"project_id\": \"<string>\",\n \"project_name\": \"<string>\",\n \"reset_mac_addresses\": true,\n \"retention_period\": 123,\n \"size_bytes\": 123,\n \"version_tag\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/project-files")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bucket_id\": \"<string>\",\n \"compression\": \"<string>\",\n \"content_type\": \"<string>\",\n \"filename\": \"<string>\",\n \"include_images\": true,\n \"include_snapshots\": true,\n \"is_read_only\": true,\n \"keep_compute_ids\": true,\n \"project_id\": \"<string>\",\n \"project_name\": \"<string>\",\n \"reset_mac_addresses\": true,\n \"retention_period\": 123,\n \"size_bytes\": 123,\n \"version_tag\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"expires_at": "<string>",
"file_uuid": "<string>",
"upload_url": "<string>"
}{
"code": "unauthorized",
"details": "invalid or missing join token",
"error": "Unauthorized"
}{
"code": "unauthorized",
"details": "invalid or missing join token",
"error": "Unauthorized"
}{
"code": "unauthorized",
"details": "invalid or missing join token",
"error": "Unauthorized"
}{
"code": "unauthorized",
"details": "invalid or missing join token",
"error": "Unauthorized"
}project-files
Initialise project file upload
Creates a file record and a project_files metadata row atomically. The fields mirror the options available on the GNS3 project export command.
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>"
}
'import requests
url = "https://api.example.com/api/v1/project-files"
payload = {
"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>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://api.example.com/api/v1/project-files', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/project-files",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/project-files"
payload := strings.NewReader("{\n \"bucket_id\": \"<string>\",\n \"compression\": \"<string>\",\n \"content_type\": \"<string>\",\n \"filename\": \"<string>\",\n \"include_images\": true,\n \"include_snapshots\": true,\n \"is_read_only\": true,\n \"keep_compute_ids\": true,\n \"project_id\": \"<string>\",\n \"project_name\": \"<string>\",\n \"reset_mac_addresses\": true,\n \"retention_period\": 123,\n \"size_bytes\": 123,\n \"version_tag\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/project-files")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"bucket_id\": \"<string>\",\n \"compression\": \"<string>\",\n \"content_type\": \"<string>\",\n \"filename\": \"<string>\",\n \"include_images\": true,\n \"include_snapshots\": true,\n \"is_read_only\": true,\n \"keep_compute_ids\": true,\n \"project_id\": \"<string>\",\n \"project_name\": \"<string>\",\n \"reset_mac_addresses\": true,\n \"retention_period\": 123,\n \"size_bytes\": 123,\n \"version_tag\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/project-files")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bucket_id\": \"<string>\",\n \"compression\": \"<string>\",\n \"content_type\": \"<string>\",\n \"filename\": \"<string>\",\n \"include_images\": true,\n \"include_snapshots\": true,\n \"is_read_only\": true,\n \"keep_compute_ids\": true,\n \"project_id\": \"<string>\",\n \"project_name\": \"<string>\",\n \"reset_mac_addresses\": true,\n \"retention_period\": 123,\n \"size_bytes\": 123,\n \"version_tag\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"expires_at": "<string>",
"file_uuid": "<string>",
"upload_url": "<string>"
}{
"code": "unauthorized",
"details": "invalid or missing join token",
"error": "Unauthorized"
}{
"code": "unauthorized",
"details": "invalid or missing join token",
"error": "Unauthorized"
}{
"code": "unauthorized",
"details": "invalid or missing join token",
"error": "Unauthorized"
}{
"code": "unauthorized",
"details": "invalid or missing join token",
"error": "Unauthorized"
}Authorizations
Type "Bearer" followed by a space and JWT token.
Body
application/json
Project file upload request
deflate|bz2|xz|zstd|none
⌘I