Get a credential
GET
/v1/credentials/{id}
const url = 'https://example.com/v1/credentials/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/v1/credentials/example \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
The cred_<uuidv7> credential ID.
Responses
Section titled “Responses”The credential (metadata only).
Media typeapplication/json
object
id
required
The cred_<uuidv7> resource ID.
string
name
required
string
auth_type
required
string
source
required
string
masked_hint
Present only for source=managed — a redacted hint of the secret, never the secret itself.
string
vault_ref
Present only for source=vault.
string
version
required
Incremented on each rotation.
integer
created_at
required
string format: date-time
updated_at
required
string format: date-time
Example
{ "auth_type": "bearer", "source": "managed"}Missing or invalid bearer token, or the token’s tenant/user claims are absent. No body.
No resource with this ID exists in the caller’s tenant.
Media typeapplication/json
The uniform error body for all 4xx responses that carry one.
object
error
required
A coarse, caller-safe message. Never contains internal state (invariant
string
Examplegenerated
{ "error": "example"}An unexpected server-side error. No body (internal detail is never returned to callers, invariant