/projects/{project_id}/branches/{branch_id}/credentials/{token_id}/revealbetaReveal a credential's secrets
Returns the live api_token and s3_secret_access_key of an existing
credential, so a credential whose issuance response was lost can be
recovered without minting a new one.
This is a POST with an explicit /reveal verb so the secrets never ride
a GET, where they would land in access logs, browser history and proxy
caches. Revoked and expired credentials return 404, as does a
token_id that does not belong to this project.
A credential issued before secret retrieval was supported has no recoverable secret and returns 409 — rotate it to obtain one.
Note: This endpoint is currently in Beta.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/credentials/$TOKEN_ID/reveal" \
-X POST \
-H "Authorization: Bearer $NEON_API_KEY"Every field below is optional. An empty body works too.
import { createNeonClient, raw } from '@neon/sdk';
const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.revealCredential({
client: neon.client,
path: {
project_id: process.env.PROJECT_ID,
branch_id: process.env.BRANCH_ID,
token_id: process.env.TOKEN_ID
}
});Parameters
project_idThe Neon project ID
branch_idThe Neon branch ID
token_idThe opaque credential id (e.g. nak_live_<32hex>).
Response
200The credential's live secrets.
Errors
Credential not found
The credential exists but has no recoverable secret because it was issued before secret retrieval was supported. Rotate the credential to obtain a recoverable secret.
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.