developer
PTEN

Cloud API

Pools

Runtimes that run the same environments together — across servers, or across clouds.

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

The object

idstring
Its id.
namestring
Its name.
descriptionstring
What it is for.
colorstring
How Cloud draws it.
membersRuntime[]
Its runtimes.
environmentsEnvironment[]
What runs on it.

List pools

GET/v1/pools

Every pool, with its members.

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

Get a pool

GET/v1/pools/{id}

One pool.

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

Create a pool

POST/v1/pools

A pool, and the runtimes that join it.

Who: Cloud admin

Body

namestringrequired
Its name.
descriptionstring
What it is for.
colorstring
gray, red, orange, amber, green, teal, sky, blue, violet or pink.
runtime_idsstring[]
Its members.
moveboolean
Whether joining runtimes’ environments move onto the pool; asked when one has some.
Request
curl -X POST https://cloud.yet.com.br/v1/pools \
  -H "Authorization: Bearer $YET_API_KEY" \
  -d '{
    "name": "web",
    "color": "violet",
    "runtime_ids": [
      "rt_01J9",
      "rt_02K4"
    ]
  }'

Change a pool

PATCH/v1/pools/{id}

Any of the fields above; runtime_ids, whole.

Who: Cloud admin

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

Open its tunnel

POST/v1/pools/{id}/tunnel

One tunnel for every member.

Who: Cloud admin

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

Close its tunnel

DELETE/v1/pools/{id}/tunnel

Takes the pool from behind its tunnel.

Who: Cloud admin

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

Delete a pool

DELETE/v1/pools/{id}

Its members stay, on their own.

Who: Cloud admin

Request
curl -X DELETE https://cloud.yet.com.br/v1/pools/{id} \
  -H "Authorization: Bearer $YET_API_KEY"
Response · 204 No Content