Authentication

How this API authenticates requests, and where your API keys live.

Neon API declares the schemes below. Each operation documents which schemes it requires; public operations need no credentials.

Your API keys

BearerAuth

HTTP Bearer

The Neon API requires an API key to authorize your requests, which you can enter below. Refer to our documentation to find out how to generate and use [API keys](https://neon.com/docs/manage/api-keys).

For operations using this scheme, send your token in the Authorization header.

curl arguments for operations using this scheme (add the operation URL):

-H 'Authorization: Bearer YOUR_API_KEY'

CookieAuth

API key (cookie)

When using this scheme, send your key in the zenith cookie.

curl arguments for operations using this scheme (add the operation URL):

-b 'zenith=YOUR_API_KEY'

TokenCookieAuth

API key (cookie)

When using this scheme, send your key in the keycloak_token cookie.

curl arguments for operations using this scheme (add the operation URL):

-b 'keycloak_token=YOUR_API_KEY'

Code example

A request using the declared server and authentication requirements:

curl --globoff -X GET -H 'Authorization: Bearer YOUR_API_KEY' 'https://console.neon.tech/api/v2/api_keys'