Skip to content
VPNDetection

Reveal

post/api/v1/iam/apikeys/{id}/reveal

Returns an existing key's secret.

It needs the apikeys.reveal scope, which apikeys.manage doesn't include.

Refused with NOT_RETRIEVABLE for a key issued before we kept secrets. Rotate that key instead.

Authorization

bearerAuthbearer token

Authorization: Bearer <key>.

Scopes: apikeys.reveal

Path parameters

idrequiredstring (uuid)

The key's ID, as returned by the list endpoint. Never the key itself.

Responses

200application/json

The key's secret.

rcrequiredstring
keyrequiredstring

The secret.

TypeScript type
ts
{
  rc: string;
  key: string;
}
401application/json

No credential was presented, or it is not valid.

rcrequiredstring

The outcome. SUCCESS on success; otherwise the reason.

TypeScript type
ts
{
  rc: string;
}
403application/json

The credential does not hold the scope this endpoint requires. The missing scope is deliberately not named.

rcrequiredstring

The outcome. SUCCESS on success; otherwise the reason.

TypeScript type
ts
{
  rc: string;
}
404application/json

No such key in this organization, or its secret was never stored recoverably (NOT_RETRIEVABLE).

rcrequiredstring

The outcome. SUCCESS on success; otherwise the reason.

TypeScript type
ts
{
  rc: string;
}