Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-26162247330.6 KB
API Key

Create API key

Creates an API key. The key_name is a user-specified name for the key. Returns an id and key; the key is a randomly generated, 64-bit token required to access the Neon API. Store the key securely — it is only returned once. API keys can also be managed in the Neon Console. See Manage API keys.

post/api_keys

Request body

key_namestring required

A user-specified API key name. This value is required when creating an API key.

Response

Created an API key

idinteger required

The API key ID

keystring required

The generated 64-bit token required to access the Neon API

namestring required

The user-specified API key name

created_atstring date-time required

A timestamp indicating when the API key was created

created_bystring uuid required

ID of the user who created this API key