Issue a scoped credential on the branch

Issues a new scoped service credential anchored to the specified
branch. The response carries api_token and s3_secret_access_key
exactly once — they are not stored server-side.

Note: This endpoint is currently in Beta.

Path Params
string
required
^[a-z0-9-]{1,60}$

The Neon project ID

string
required
^[a-z0-9-]{1,60}$

The Neon branch ID

Body Params
string
length ≤ 256

Free-form customer label for the credential.

scopes
array of objects
required
length between 1 and 16
scopes*
Allowed:

A single capability you may request when issuing a credential. A
credential is granted a set of these; it may only perform actions
explicitly listed in its scopes.

This is the requestable set. Responses describing an existing
credential use GrantedCredentialScope, which is deliberately wider:
a credential may have been granted a scope that this endpoint does not
offer, and a response must be able to report it.

string
enum
required

Principal type for the credential. Only user is customer-managed
and accepted here. function and system credentials are
platform-internal (e.g. function-serve auto-mint, presign signer)
and are never issued through the customer-facing API.

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json