Neon API (unofficial showcase)
POST/projects/{project_id}/branches/{branch_id}/credentials/{token_id}/reveal

Reveal 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.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 parameters
project_idstringrequired
The Neon project ID
branch_idstringrequired
The Neon branch ID
token_idstringrequired
The opaque credential id (e.g. nak_live_<32hex>).

4 status codes
200The credential's live secrets.
token_idstringrequired
Opaque credential id (e.g. nak_live_<32hex>).
api_tokenstringrequired
Bearer token.
s3_secret_access_keystringrequired
nsk_live_<64 hex>; the AWS_SECRET_ACCESS_KEY.
404Credential not found
request_idstringoptional
Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message
409The credential exists but has no recoverable secret because it was issued before secret retrieval was supported. Rotate the credential to obtain a recoverable secret.
request_idstringoptional
Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message
defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.
request_idstringoptional
Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message

Error handling

A 404 is returned: Credential not found. A 409 is returned: 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. Any other status is an error: General Error.

The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received.

  • If no response is returned from the API, a network error or timeout likely occurred.
  • In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.

The following HTTP methods are considered non-idempotent: POST, PATCH, DELETE, and PUT. Retrying these methods is generally not safe. The following methods are considered idempotent: GET, HEAD, and OPTIONS. Retrying these methods is safe in the event of a network error or timeout.

Any request that returns a 503 Service Unavailable response is always safe to retry.

Any request that returns a 423 Locked response is safe to retry. 423 Locked indicates that the resource is temporarily locked, for example, due to another operation in progress.