Cloud API

Servers

A machine of a local rack, which Yet’s agent runs on. Made, it waits for its machine: a join token, run there, brings it online.

Base URL https://cloud.yet.com.br/v1

The object

idstring: Its id.
namestring: Lowercase letters, digits and dashes, up to 32.
rack_idstring: Its rack.
status"pending" | "online" | "offline": Pending until its agent first comes in.
hostnamestring: The machine’s own name, as its agent says.
osstring: linux, darwin or windows.
archstring: amd64 or arm64.

List servers

GET/v1/servers

Every server, with how it stands.

Request

curl https://cloud.yet.com.br/v1/servers \
  -H "Authorization: Bearer $YET_API_KEY"

Get a server

GET/v1/servers/{id}

One server, with its runtimes and what runs there.

Request

curl https://cloud.yet.com.br/v1/servers/{id} \
  -H "Authorization: Bearer $YET_API_KEY"

Create a server

POST/v1/servers

A server waiting for its machine.

Who: Cloud admin

Body

namestringrequired: Its name.
rack_idstring: Its rack; the company’s only local one when left out.

Request

curl -X POST https://cloud.yet.com.br/v1/servers \
  -H "Authorization: Bearer $YET_API_KEY" \
  -d '{
    "name": "box"
  }'

Response · 201

{
  "id": "sv_01J9",
  "name": "box",
  "rack_id": "rk_01J9",
  "status": "pending",
  "created_at": "2026-10-23T12:00:00Z"
}

Make a join token

POST/v1/servers/{id}/join

A one-time token, and the commands that run the agent with it — on Linux (Docker), a Mac, or Windows.

Who: Cloud admin

Request

curl -X POST https://cloud.yet.com.br/v1/servers/{id}/join \
  -H "Authorization: Bearer $YET_API_KEY"

Response · 201

{
  "token": "yetjoin_acme_…",
  "expires_at": "2026-10-23T12:00:00Z",
  "command": "curl -fsSL https://cloud.yet.com.br/join/yetjoin_acme_….sh | sh",
  "docker": "docker run -d --name yetd … ghcr.io/yetcombr/yetd",
  "mac": "curl -fsSL https://cloud.yet.com.br/join/yetjoin_acme_….mac.sh | sudo sh",
  "windows": "irm https://cloud.yet.com.br/join/yetjoin_acme_….ps1 | iex"
}

Rename a server

PATCH/v1/servers/{id}

Its runtimes refer to it by id.

Who: Cloud admin

Body

namestringrequired: Its new name.

Request

curl -X PATCH https://cloud.yet.com.br/v1/servers/{id} \
  -H "Authorization: Bearer $YET_API_KEY" \
  -d '{
    "name": "office-box"
  }'

Delete a server

DELETE/v1/servers/{id}

Once no runtime runs on it.

Who: Cloud admin

Request

curl -X DELETE https://cloud.yet.com.br/v1/servers/{id} \
  -H "Authorization: Bearer $YET_API_KEY"

Response · 204 No Content