Organizations

Create organization API key

Creates an API key for the specified organization. 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/organizations/{org_id}/api_keys

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/organizations/{org_id}/api_keys
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Request body

key_namestring required

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

project_idstring

If set, the API key can access only this project

Response

Created an organization 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

project_idstring

If set, the API key can access only this project

Changes

No recorded changes to this operation across all 1 revision of this API.