Ask for an environment: it is planned and priced, then waits for an owner
POST
/v1/organisations/{id}/environmentsOperation environments.create · since 2026-11-05 · stable
Needs a session withwritescopeAnswers201 Created
{ "id", "slug", "cloud", "region" }. Rykloud then plans and prices it; nothing starts until an owner approves that price with environments.approve.
Path parameters
- idstring (uuid)required
- The organisation id.
Body (JSON)
- namestring, 1 to 60required
- The environment's name.
- cloudstringrequired
- "hetzner", "aws", "gcp", "azure", or "any" with a family size for the cheapest place in area.
- regionstringrequired
- The region (ignored with cloud any).
- sizestringrequired
- The size, from environments.options, for example general-s.
- areastringoptional
- With cloud any: "us", "eu" or "asia".
- resiliencestringoptional
- "single_zone" (default), "multi_zone" or "multi_region".
- productsarray of { name, channel }optional
- Products to run in it, at most 5 (default none).
- ttlstring or nulloptional
- A time limit after which it is stopped and kept, like 8h or 3d (default 8h); null for none.
- stagestringoptional
- "production", "staging", "development" or "preview".
- projectIdstring (uuid)optional
- The project it belongs to.
- cloudAccountIdstring (uuid)optional
- The organisation's own cloud account, when it has one; else the shared tier.
- templatestringoptional
- A starting point, by id.
- team{ seats, mailboxes }optional
- An AI team in the environment: seats 0 to 1000, mailboxes 0 to 10000.
Errors
Every error is { "error", "message", "detail"? } (Errors and references). Besides the codes any route can answer, this one refuses with:
- not_allowed
- no_place
- data_location
- coming_soon
- limit_live
- limit_spend
- limit_account_budget
- not_ready
POST/v1/organisations/{id}/environments
curl -X POST "https://api.rykloud.com/v1/organisations/$ORG_ID/environments" \
-H "Authorization: Bearer $RYKLOUD_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "staging",
"cloud": "any",
"region": "any",
"area": "eu",
"size": "general-s",
"stage": "staging",
"ttl": "8h"
}'With the rykloud CLI
rykloud envs create NAME [flags]Command reference: rykloud envs create