Autoscaling Report: Production databases on Neon use 2.4x less compute and 50% less cost than if they were running on a provisioned platform.
Neon
    Docs
    Log inSign up
    /API reference/API Keys/Create API key
    POST/api_keys

    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.

    Markdown for AI context

    Quick start

    REST API - curl
    curl "https://console.neon.tech/api/v2/api_keys" \
  -X POST \
  -H "Authorization: Bearer $NEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key_name":"mykey"}'
    Also available in
    import { createApiClient } from '@neondatabase/api-client';

const api = createApiClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await api.createApiKey({
  "key_name": "mykey"
});

    Request body

    1 required Required: key_name.

    Key name
    key_name
    string

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

    ≤64 chars

    Response

    200

    Created an API key

    Depth
    "id": (integer),reqint64
    "key": (string),req
    "name": (string),req
    "created_at": (string),reqdate-time
    "created_by": (string),requuid

    Errors

    default

    General error

    This endpoint can return the standard Neon API error response.

    Response fields

    • message Required. Human-readable error message.
    • code Required. Machine-readable error code.
    • request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

    Retry guidance

    If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

    Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

    Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.

    Was this page helpful?
    Previous List API keysNext Revoke API key

    On this page

    Copy neon init command