Cloud API

Pools

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

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

As descrições dos endpoints estão em inglês.

O objeto

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.

Requisição

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

Get a pool

GET/v1/pools/{id}

One pool.

Requisição

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.

Quem: Cloud admin

Corpo

namestringobrigatório: 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.

Requisição

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.

Quem: Cloud admin

Requisição

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.

Quem: Cloud admin

Requisição

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.

Quem: Cloud admin

Requisição

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.

Quem: Cloud admin

Requisição

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

Resposta · 204 Sem conteúdo