Cloud API

Environments

Where a stage of the company’s applications runs — staging, production — on one runtime or one pool, and the domain it answers at. Each is a Kubernetes namespace of its own, `yet-<name>`.

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

The object

idstring: Its id.
namestring: Never changed.
colorstring: How Cloud draws it.
runtime_idstring: Its runtime — or pool_id.
pool_idstring: Its pool — or runtime_id.
zone_idstring: The DNS zone it answers in.
prefixstring: What goes before the zone’s name.
domainstring: Where its applications answer.
dns"ok" | "unreachable" | "outside" | "": How its records stand.

List environments

GET/v1/environments

The environments the key’s person has a role in.

Request

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

Create an environment

POST/v1/environments

On a runtime or a pool, in a zone or not.

Who: Cloud admin

Body

namestringrequired: Lowercase letters, digits and dashes, up to 32.
colorstring: gray unless set.
runtime_idstring: Its runtime — or pool_id.
pool_idstring: Its pool — or runtime_id.
zone_idstring: Its zone.
prefixstring: staging makes it staging.<zone>.

Request

curl -X POST https://cloud.yet.com.br/v1/environments \
  -H "Authorization: Bearer $YET_API_KEY" \
  -d '{
    "name": "staging",
    "color": "amber",
    "runtime_id": "rt_01J9",
    "zone_id": "zn_01J9",
    "prefix": "staging"
  }'

Response · 201

{
  "id": "en_01J9",
  "name": "staging",
  "color": "amber",
  "runtime_id": "rt_01J9",
  "pool_id": "",
  "zone_id": "zn_01J9",
  "prefix": "staging",
  "domain": "staging.acme.dev",
  "created_at": "2026-10-23T12:00:00Z"
}

Change an environment

PATCH/v1/environments/{id}

Its colour, its domain, or where it runs — only while nothing is deployed there, or between a pool and one of its members.

Who: Cloud admin

Request

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

Delete an environment

DELETE/v1/environments/{id}

Once no application has it as a stage.

Who: Cloud admin

Request

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

Response · 204 No Content