Skip to the page

A resource with its status, settings and backups

GET/v1/organisations/{id}/environments/{envId}/resources/{rid}

Operation resources.get · since 2026-11-05 · stable

Needs a session withreadscopeAnswers200 OK

The resource: its status, settings, connections and backups.

Path parameters

idstring (uuid)required
The organisation id.
envIdstring (uuid)required
The environment id.
ridstringrequired
The resource id, or its name.

Errors

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

GET/v1/organisations/{id}/environments/{envId}/resources/{rid}
curl "https://api.rykloud.com/v1/organisations/$ORG_ID/environments/$ENV_ID/resources/$RESOURCE_ID" \
  -H "Authorization: Bearer $RYKLOUD_TOKEN"
With the rykloud CLI
rykloud resources get RESOURCE

Command reference: rykloud resources get