Skip to the page

Preview a settings change with its price

POST/v1/organisations/{id}/environments/{envId}/settings/preview

Operation settings.preview · since 2026-11-05 · stable

Needs a session withwritescopeAnswers200 OK

A previewed change: its id, what it does, its price and how long the preview stands. Apply it with settings.apply.

Path parameters

idstring (uuid)required
The organisation id.
envIdstring (uuid)required
The environment id.

Body (JSON)

kindstringrequired
"egress", "vpn", "backups", "pools" or "services": which part changes.
egress{ mode }optional
With kind egress: mode "nodes" or "fixed" (fixed outgoing addresses).
vpn{ enabled, allow }optional
With kind vpn: on or off, and allow as up to 50 { namespace, service, port }.
backupsobjectoptional
With kind backups: enabled, time, timezone, schedule, keep { daily, weekly, monthly }, copy (a second region), restoreTest { enabled, day, time }, resource.
poolsarray of { name, min, max }optional
With kind pools: 1 to 10 node pools and their bounds.
servicesarray of { service, min, max, cpu }optional
With kind services: 1 to 50 services and their replica bounds.

Errors

Every error is { "error", "message", "detail"? } (Errors and references). Besides the codes any route can answer.

POST/v1/organisations/{id}/environments/{envId}/settings/preview
curl -X POST "https://api.rykloud.com/v1/organisations/$ORG_ID/environments/$ENV_ID/settings/preview" \
  -H "Authorization: Bearer $RYKLOUD_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "backups",
  "backups": {
    "enabled": true,
    "time": "03:00",
    "timezone": "Europe/London",
    "keep": {
      "daily": 7,
      "weekly": 4,
      "monthly": 3
    }
  }
}'