Publish files in one request
curl --request POST \
--url https://api.cool.computer/api/publish \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/x-tar' \
--data '"<string>"'import requests
url = "https://api.cool.computer/api/publish"
payload = "<string>"
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/x-tar"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/x-tar'},
body: JSON.stringify('<string>')
};
fetch('https://api.cool.computer/api/publish', 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/publish",
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('<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/publish"
payload := strings.NewReader("\"<string>\"")
req, _ := http.NewRequest("POST", 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.post("https://api.cool.computer/api/publish")
.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/publish")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/x-tar'
request.body = "\"<string>\""
response = http.request(request)
puts response.read_body{
"computer": {
"id": "<string>",
"hostname": "<string>",
"slug": "<string>",
"ip": "<string>",
"status": "<string>",
"visibility": "private",
"access": "owner",
"site": true,
"network_policy": {
"mode": "open",
"allowed_hosts": [
"api.example.com"
]
},
"created_at": "2023-11-07T05:31:56Z",
"public_url": "<string>",
"email_address": "jsmith@example.com",
"auto_delete_at": "2023-11-07T05:31:56Z",
"creation_mode": "<string>"
},
"release": {
"number": 2,
"state": "uploading",
"live": true,
"files": 1,
"bytes": 1,
"created_at": "2023-11-07T05:31:56Z",
"ready_at": "2023-11-07T05:31:56Z"
},
"url": "<string>",
"vm": true,
"next": {
"action": "upload",
"upload": {
"method": "PUT",
"href": "<string>"
},
"finalize": {
"method": "PUT",
"href": "<string>"
}
},
"release_url": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}Publishing
Publish files in one request
Publishes a whole release in one body: a tar, gzip-compressed tar or zip archive, or one HTML page served as index.html. Archives may hold only regular files and directories; an entry whose mode has any execute bit is executable. Without computer, creates a computer that serves the files with no VM; with computer, makes them that computer's new live release. A cool.json at the release root configures serving: spa, and run with an optional port, a shortcut for starting a server by hand: the computer gets its VM if it has none, the files are written to /home/runtime/app and served from there, and run starts there as the managed service, answering every path no file matches; or functions, the path of one bundled .js or .mjs ES module of at most 1 MiB that answers every /api/ request, with secrets, the slug of an account secret set whose keys it gets as env (a key delivered by proxy only once the computer has its VM, as the placeholder runtime-proxy, its value set as Authorization by the computer's egress proxy on the https requests its rule matches); a release cannot declare both functions and run. The body is validated, cool.json included, before anything is created, and a computer this request created is deleted again if a later step fails. Limits: 20,000 files, 25 MiB per file and 1 GiB in total; a release that declares run holds at most 10,000 files and 512 MiB. Send an Idempotency-Key: a retry of the same request with the same key returns the original response or finishes that release, and never publishes again. Without any credential, it publishes without an account: files only (a release that declares run or functions answers 403 sign_in_required_for_servers), at most 1,000 files, 10 MiB per file and 100 MiB in total, and at most 20 such publishes per client IP per hour and 10 unclaimed computers per client IP, 50 per IPv6 /48, at once (429 anonymous_publish_rate_exceeded or unclaimed_computer_limit). The created computer is public and is deleted 24 hours later unless someone claims it; the response adds claim_key, returned only once, claim_url, whose fragment carries the computer ID and the key, and expires_at. To publish to that computer again before then, send ?computer=<computer ID> with Authorization: Claim <claim_key>; that does not extend expires_at. A signed-in user claims the computer with POST /api/computers/{id}/claim. A publish without an account takes no Idempotency-Key (400 idempotency_key_requires_account), because its response carries the claim key.
POST
/
api
/
publish
Publish files in one request
curl --request POST \
--url https://api.cool.computer/api/publish \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/x-tar' \
--data '"<string>"'import requests
url = "https://api.cool.computer/api/publish"
payload = "<string>"
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/x-tar"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/x-tar'},
body: JSON.stringify('<string>')
};
fetch('https://api.cool.computer/api/publish', 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/publish",
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('<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/publish"
payload := strings.NewReader("\"<string>\"")
req, _ := http.NewRequest("POST", 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.post("https://api.cool.computer/api/publish")
.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/publish")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/x-tar'
request.body = "\"<string>\""
response = http.request(request)
puts response.read_body{
"computer": {
"id": "<string>",
"hostname": "<string>",
"slug": "<string>",
"ip": "<string>",
"status": "<string>",
"visibility": "private",
"access": "owner",
"site": true,
"network_policy": {
"mode": "open",
"allowed_hosts": [
"api.example.com"
]
},
"created_at": "2023-11-07T05:31:56Z",
"public_url": "<string>",
"email_address": "jsmith@example.com",
"auto_delete_at": "2023-11-07T05:31:56Z",
"creation_mode": "<string>"
},
"release": {
"number": 2,
"state": "uploading",
"live": true,
"files": 1,
"bytes": 1,
"created_at": "2023-11-07T05:31:56Z",
"ready_at": "2023-11-07T05:31:56Z"
},
"url": "<string>",
"vm": true,
"next": {
"action": "upload",
"upload": {
"method": "PUT",
"href": "<string>"
},
"finalize": {
"method": "PUT",
"href": "<string>"
}
},
"release_url": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"resolution": "<string>",
"context": {}
}Authorizations
bearerAuthclaimKeyAuth
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.
Headers
A caller-generated key for safely retrying this side effect. The server retains the key and response for 24 hours. Reusing it with the same request replays the original response; reusing it with different input returns 409.
Required string length:
1 - 128Pattern:
^[!-~]+$Example:
"req_01J6M6Y9TF9Q9QF6M1ZP8K4R2A"
Query Parameters
Existing computer ID or slug to publish to. Omit it to create a computer. Without an account, only the unclaimed computer the Claim key belongs to.
Minimum string length:
1Slug for a created computer. Unless the release declares run, it must leave room for release hostnames up to r9999--, so 56 characters at most; slug_too_long_for_releases otherwise.
Pattern:
^[a-z0-9]{1,63}$Body
application/x-tarapplication/gzipapplication/ziptext/html
The body is of type file.
Response
The computer and the receipt of its new live release. A publish without an account answers AnonymousPublishResult.
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The computer's URL, which serves the live release.
Whether the computer's VM serves its URL, because a server on it answered.
What to do next: upload the missing hashes, finalize, or nothing (done).
Show child attributes
Show child attributes
This release's own hostname r--. Absent once the computer's VM serves its URL.