Get started

Conventions

How every endpoint behaves: what it takes, what it answers, and how it says no.

JSON in, JSON out

Requests with a body send JSON; every answer is JSON. Fields are snake_case; times are RFC 3339, in UTC. Cloud refuses fields it does not know, so a typo never passes silently.

Changes

POST makes something, and answers 201 with it.
PATCH changes only the fields sent; the rest stay.
PUT sets a whole thing — a record’s values, the apps turned off.
DELETE answers 204, with no body — or { "ok": true } in Settings.

Errors

A refusal carries Yet’s own words — the ones its apps show — under error:

json

{ "error": "There is an environment with that name already." }

Status	Means
`400`	The request is not right: a field missing, or not as it should be.
`401`	No key, or not a key Yet knows.
`403`	The key’s person may not do that.
`404`	No such thing — or not one the key may see.
`409`	It clashes with what is there: a name taken, something still in use.
`5xx`	Yet’s side. Try again; it is safe for reads.

Names

Cloud’s names — servers, runtimes, environments, databases — become Kubernetes names: lowercase letters, digits and dashes, up to 32, starting with a letter. An environment’s is never changed; the rest can be.

Ids

Things are referred to by id, never by name: renaming one breaks nothing that points at it. The Terraform data sources find an id by its name.