Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Neon API Keys API

Manage API keys for authentication. API keys are used to authenticate requests to the Neon API via Bearer token.

Neon API Keys API is one of 13 APIs that Neon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include API Keys. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://console.neon.tech/api/v2.

3 operations 2 paths 3 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://console.neon.tech/api/v2
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Neon API Keys API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Key) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Neon API keys are used to authenticate requests. Include the API key in the Authorization header as a Bearer token.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

API Keys 3

Manage API keys for authentication. API keys are used to authenticate requests to the Neon API via Bearer token.

GET
/api_keys
List API keys
listApiKeys → 200401
POST
/api_keys
Create an API key
createApiKey body → 200400401
DELETE
/api_keys/{key_id}
Revoke an API key
revokeApiKey 1 param → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ApiKey (5 properties), ApiKeyCreateResponse (2 properties), ApiKeyCreateRequest (1 property). Each schema is shown below with its type and property counts.

ApiKeyCreateRequest
object
Request body for creating a new API key
1 property 1 required
ApiKey
object
An API key used to authenticate requests to the Neon API
5 properties
ApiKeyCreateResponse
object
Response containing the newly created API key
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neon-api-keys-api-openapi.yml Raw ↑

Other APIs Neon publishes across the network.

Neon Data API
Neon Serverless Driver
Neon Auth
Neon Auth API
Neon Branches API
Neon Consumption API
Neon Data API API
Neon Databases API
Neon Endpoints API
Neon Operations API
Neon Projects API
Neon Roles API