Skip to the page

Ask for a private link to another environment

POST/v1/organisations/{id}/environments/{envId}/links

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

Needs a session withwritescopeAnswers201 Created

Path parameters

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

Body (JSON)

tostring (uuid)required
The environment to link to.
allowarray of { namespace, service, port }optional
What the other environment may reach here (up to 50).
reacharray of { namespace, service, port }optional
What this environment asks to reach there (up to 50).

Errors

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

POST/v1/organisations/{id}/environments/{envId}/links
curl -X POST "https://api.rykloud.com/v1/organisations/$ORG_ID/environments/$ENV_ID/links" \
  -H "Authorization: Bearer $RYKLOUD_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "00000000-0000-4000-8000-000000000000"
}'