Reveal a database's connection details (audited)
POST
/v1/organisations/{id}/environments/{envId}/resources/{rid}/credentialsOperation resources.credentials · since 2026-11-05 · stable
Needs a session withwritescopeAnswers200 OKanswers a secret
A Postgres database's { "username", "password", "database", "host", "port", "uri" }. Never cached; every reveal is recorded in activity.
This answer holds a secret
It is sent with
cache-control: no-store and every call is recorded in the organisation's activity. Do not log it.Path parameters
- idstring (uuid)required
- The organisation id.
- envIdstring (uuid)required
- The environment id.
- ridstringrequired
- The resource id (or name, where the route accepts one).
Body
None. Send no body, or an empty JSON object.
Errors
Every error is { "error", "message", "detail"? } (Errors and references). Besides the codes any route can answer, this one refuses with:
- no_credentials
- wrong_state
- not_allowed
POST/v1/organisations/{id}/environments/{envId}/resources/{rid}/credentials
curl -X POST "https://api.rykloud.com/v1/organisations/$ORG_ID/environments/$ENV_ID/resources/$RESOURCE_ID/credentials" \
-H "Authorization: Bearer $RYKLOUD_TOKEN"With the rykloud CLI
rykloud resources credentials RESOURCECommand reference: rykloud resources credentials