Neon Roles API
Manage Postgres roles within a branch. Roles control database access and permissions.
Neon Roles API is one of 13 APIs that Neon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 3 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Neon Roles 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 5
Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Manage Postgres roles within a branch. Roles control database access and permissions.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Operation (9 properties), Role (6 properties), RoleCreateRequest (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Neon 12
Other APIs Neon publishes across the network.