API Reference

The SerenDB API allows you to manage your SerenDB projects programmatically.

Refer to the SerenDB API reference for supported methods.

The SerenDB API is a REST API. It provides resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and supports standard HTTP response codes, authentication, and verbs.

Working with AI coding assistants? Check out our [AI rules for the SerenDB API](/docs/ai/ai-rules-neon-api) to help your AI assistant understand authentication, rate limiting, and best practices when working with the SerenDB API.

Authentication

The SerenDB API uses API keys to authenticate requests. You can view and manage API keys for your account in the SerenDB Console. For instructions, refer to Manage API keys.

The client must send an API key in the Authorization header when making requests, using the bearer authentication scheme. For example:

curl 'https://console.serendb.com/api/v2/projects' \
  -H 'Accept: application/json' \
  -H "Authorization: Bearer $NEON_API_KEY" \
  -H 'Content-Type: application/json' \

SerenDB API base URL

The base URL for a SerenDB API request is:

https://console.serendb.com/api/v2/

Append a SerenDB API method path to the base URL to construct the full URL for a request. For example:

https://console.serendb.com/api/v2/projects/{project_id}/branches/{branch_id}

Using the SerenDB API reference to construct and execute requests

You can use the SerenDB API reference to execute SerenDB API requests. Select an endpoint, enter an API key token in the Bearer field in the Authorization section, and supply any required parameters and properties. For information about obtaining API keys, see Manage API keys.

The SerenDB API reference also provides request and response body examples that you can reference when constructing your own requests.

For additional SerenDB API examples, refer to the following topics:

When using the SerenDB API programmatically, you can poll the operation `status` to ensure that an operation is finished before proceeding with the next API request. For more information, see [Poll operation status](/docs/manage/operations#poll-operation-status).

API rate limiting

SerenDB limits API requests to 700 requests per minute (about 11 per second), with bursts allowed up to 40 requests per second per route, per account. If you exceed this, you'll receive an HTTP 429 Too Many Requests error. These limits apply to all public API requests, including those made by the SerenDB Console. Limits may change, so make sure your app handles 429 errors and retries appropriately. Contact support if you need higher limits.

PreviousReferenceNextSDK

Last updated