Set public visibility

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

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

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.cool.computer/api/computers/{id}/visibility")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

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

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/json'
request.body = "{}"

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

{
  "id": "<string>",
  "hostname": "<string>",
  "name": "<string>",
  "ip": "<string>",
  "status": "<string>",
  "visibility": "private",
  "access": "owner",
  "copy_enabled": true,
  "site": true,
  "network_policy": {
    "mode": "open",
    "allowed_hosts": [
      "api.example.com"
    ]
  },
  "created_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "email_address": "jsmith@example.com",
  "auto_delete_at": "2023-11-07T05:31:56Z",
  "creation_mode": "<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>"
  ]
}

PUT

api

computers

{id}

visibility

Set public visibility

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

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

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.cool.computer/api/computers/{id}/visibility")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

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

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/json'
request.body = "{}"

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

{
  "id": "<string>",
  "hostname": "<string>",
  "name": "<string>",
  "ip": "<string>",
  "status": "<string>",
  "visibility": "private",
  "access": "owner",
  "copy_enabled": true,
  "site": true,
  "network_policy": {
    "mode": "open",
    "allowed_hosts": [
      "api.example.com"
    ]
  },
  "created_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "email_address": "jsmith@example.com",
  "auto_delete_at": "2023-11-07T05:31:56Z",
  "creation_mode": "<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"

Body

application/json

visibility

enum<string>

required

Available options:

public,

private

Response

The current computer state.

string

required

hostname

string

required

name

string

required

string

required

status

string

required

artifact (no VM), creating, running, stopped while its account's Pro has lapsed (its VM is stopped and deleted at auto_delete_at unless Pro returns; once Pro returns it can show running briefly until the reconciler has started its VM), or deleting from when its deletion begins until it is gone.

visibility

enum<string>

required

Available options:

private,

public

access

enum<string>

required

What the caller holds: owner, can_use for a computer shared with them, or claim_key in the response to a publish without an account, whose claim key republishes to the computer and claims it.

Available options:

owner,

can_use,

claim_key

copy_enabled

boolean

required

People other than the owner may copy the computer into their own accounts (PUT /api/computers/{id}/copy-settings).

site

boolean

required

The URL serves the computer's published files: from the edge, or from its VM's built-in site server until a port is first exposed, when the program on it takes every path but the functions' for good.

network_policy

object

required

Outbound access policy. open allows public destinations, none blocks outbound access, and allowlist permits only the named public hosts. Private and reserved addresses remain blocked.

Show child attributes

created_at

string<date-time>

required

url

string<uri>

email_address

string<email>

auto_delete_at

string<date-time> | null

When the computer is deleted by itself: its own auto-delete deadline, or, for a VM of an account whose Pro lapsed, when its stopped VMs are deleted, whichever comes first.

creation_mode

string

Start here

Connect your agent

Your computer

Use it

Build with the API

Endpoint reference

Set public visibility

Authorizations

Path Parameters

Body

Response