Upload a file tree

curl --request PUT \
  --url https://api.cool.computer/api/computers/{id}/files/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-tar' \
  --data '<string>'

import requests

url = "https://api.cool.computer/api/computers/{id}/files/upload"

payload = "<string>"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/x-tar"
}

response = requests.put(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/x-tar'},
  body: '<string>'
};

fetch('https://api.cool.computer/api/computers/{id}/files/upload', 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.cool.computer/api/computers/{id}/files/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "<string>",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/x-tar"
  ],
]);

$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.cool.computer/api/computers/{id}/files/upload"

	payload := strings.NewReader("<string>")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/x-tar")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.cool.computer/api/computers/{id}/files/upload")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/x-tar")
  .body("<string>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cool.computer/api/computers/{id}/files/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/x-tar'
request.body = "<string>"

response = http.request(request)
puts response.read_body

{
  "path": "<string>",
  "files": 1,
  "dirs": 1,
  "bytes": 1
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

Files

Upload a file tree

Extracts a tar archive beneath one destination directory on the persistent disk, creating the destination as needed. The archive accepts at most 10,000 entries, 64 MiB per file, and 512 MiB in aggregate. On a computer with a VM, each new entry gets the permission bits it carries, 0000 included; a directory missing for an entry inside it, the destination’s included, gets 0755, and a directory that was there before the upload keeps its own mode, as with cp and scp. List each directory before the entries inside it: a directory entry other than 0755 after an entry that already made that directory is refused (400 upload_directory_order), and what the upload put in that directory is removed, the directory with it, so the upload in order makes it with its mode; a directory that also holds what another writer added stays, as does a file another writer replaced, and the refusal names them. On a published site with no VM, its regular files, 64 MiB in all, are published as a new release under /home/runtime/app instead, never creating a VM: each keeps only whether it is executable (0755 or 0644), directory entries and their modes are ignored, and no order is refused.

PUT

api

computers

{id}

files

upload

Upload a file tree

curl --request PUT \
  --url https://api.cool.computer/api/computers/{id}/files/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-tar' \
  --data '<string>'

import requests

url = "https://api.cool.computer/api/computers/{id}/files/upload"

payload = "<string>"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/x-tar"
}

response = requests.put(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/x-tar'},
  body: '<string>'
};

fetch('https://api.cool.computer/api/computers/{id}/files/upload', 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.cool.computer/api/computers/{id}/files/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "<string>",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/x-tar"
  ],
]);

$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.cool.computer/api/computers/{id}/files/upload"

	payload := strings.NewReader("<string>")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/x-tar")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.cool.computer/api/computers/{id}/files/upload")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/x-tar")
  .body("<string>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cool.computer/api/computers/{id}/files/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/x-tar'
request.body = "<string>"

response = http.request(request)
puts response.read_body

{
  "path": "<string>",
  "files": 1,
  "dirs": 1,
  "bytes": 1
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

A Cool Computers API key, user access token, or claimed agent access token in the Authorization header. Follow https://www.cool.computer/auth.md for agent registration and https://www.cool.computer/authentication.md for direct user credentials.

Path Parameters

string

required

The computer's name, such as agent-atlas, or its id (cmp_…). Every caller may use either, the computer's own runtime token included.

Minimum string length: 1

Example:

"agent-atlas"

Query Parameters

path

string

required

Path inside the computer. A relative path is relative to /home/runtime, or to /home/runtime/app on a published site without a VM.

Minimum string length: 1

Example:

"/home/runtime/app.txt"

Body

application/x-tar

The body is of type file.

Response

The extracted file tree totals.

path

string

required

files

integer

required

Required range: x >= 0

dirs

integer

required

Required range: x >= 0

bytes

integer<int64>

required

Required range: x >= 0

Start here

Connect your agent

Your computer

Use it

Build with the API

Endpoint reference

Upload a file tree

Authorizations

Path Parameters

Query Parameters

Body

Response