How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Netlify Database API

The database API from Netlify — 14 operation(s) for database.

Netlify Database API is one of 42 APIs that Netlify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Database. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 19 operations across 14 paths. It is described by OpenAPI 3.2.0, at version 2.57.0.

Requests are made against a single base URL, https://api.netlify.com/api/v1.

19 operations 14 paths 0 schemas 4 DELETE7 GET6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.57.0
Base URL
https://api.netlify.com/api/v1/
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Netlify Database API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (netlifyAuth) using the implicit flow. By default, every request must be authenticated.

Paths & Operations 19

Across 14 paths, the API surfaces 19 operations — 4 DELETE, 7 GET, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

database 19
POST
/sites/{site_id}/database
Creates a new database for the specified site. If a database already exists, returns the existing connection string. The database region defaults to the site's functions region if not specified.
createSiteDatabase 1 param body → 200201default
GET
/sites/{site_id}/database
Returns the database connection string for the specified site.
getSiteDatabase 2 params → 200default
DELETE
/sites/{site_id}/database
Deletes the database and all associated branches and snapshots for the specified site.
deleteSiteDatabase 1 param → 204default
POST
/sites/{site_id}/database/branch
Creates a new database branch. If a branch already exists for the specified branch ID, returns the existing connection string.
createSiteDatabaseBranch 1 param body → 200201default
GET
/sites/{site_id}/database/branches
Returns all branches for the site's database with compute status and metadata.
listSiteDatabaseBranches 1 param → 200default
GET
/sites/{site_id}/database/branch/{branch_id}
Returns the database branch connection string for a specific branch.
getSiteDatabaseBranch 3 params → 200404default
DELETE
/sites/{site_id}/database/branch/{branch_id}
Deletes a database branch.
deleteSiteDatabaseBranch 2 params → 204default
POST
/sites/{site_id}/database/branch/{branch_id}/reset
Resets a non-production database branch by re-forking it from a source branch (defaults to the production branch). If the target branch is already in sync with the source, returns the existing connec…
resetSiteDatabaseBranch 4 params body → 200400404default
PUT
/sites/{site_id}/database/branch/{branch_id}/compute/settings
Sets compute settings for a specific database branch, overriding project-level settings. Requires a Pro or higher plan.
setSiteDatabaseBranchComputeSettings 2 params body → 200403default
PUT
/sites/{site_id}/database/compute/settings
Sets project-level compute settings for the database. Applied to new branches. Can be overridden per-branch. Requires a Pro or higher plan.
setSiteDatabaseComputeSettings 1 param body → 200403default
GET
/sites/{site_id}/database/compute/settings
Returns the project-level compute settings for the database. Returns effective settings (custom or tier defaults). Requires a Pro or higher plan.
getSiteDatabaseComputeSettings 1 param → 200403default
DELETE
/sites/{site_id}/database/compute/settings
Resets project-level compute settings to tier defaults. Requires a Pro or higher plan.
clearSiteDatabaseComputeSettings 1 param → 204403default
GET
/sites/{site_id}/database/migrations
Returns the list of migrations available for the specified branch, indicating which ones have been applied to the database.
listSiteDatabaseMigrations 2 params → 200404423default
GET
/sites/{site_id}/database/migrations/{name}
Returns the contents of a named migration for the specified branch.
getSiteDatabaseMigration 3 params → 200404423default
POST
/sites/{site_id}/database/migrations/{deploy_id}
Runs database migrations for the specified deploy. Finds the deploy and determines the appropriate branch.
runSiteDatabaseMigrations 2 params body → 200409422default
POST
/sites/{site_id}/database/snapshot
Creates a point-in-time snapshot of a database branch. Defaults to the production branch if no branch name is specified.
createSiteDatabaseSnapshot 1 param body → 201default
GET
/sites/{site_id}/database/snapshots
Returns all snapshots for the site's database.
listSiteDatabaseSnapshots 1 param → 200default
DELETE
/sites/{site_id}/database/snapshot/{snapshot_id}
Deletes a database snapshot.
deleteSiteDatabaseSnapshot 2 params → 204default
POST
/sites/{site_id}/database/snapshot/{snapshot_id}/restore
Restores a snapshot to a database branch. Defaults to the production branch if no branchname is specified.
restoreSiteDatabaseSnapshot 2 params body → 200default

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netlify-database-api-openapi.yml Raw ↑

Other APIs Netlify publishes across the network.

Netlify accessToken API
Netlify accountMembership API
Netlify accountType API
Netlify Asset API
Netlify assetPublicSignature API
Netlify auditLog API
Netlify Build API
Netlify buildHook API
Netlify buildLogMsg API
Netlify Deploy API
Netlify deployedBranch API
Netlify deployKey API
Where this information came from

This is an independent, third-party profile of Netlify Database API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.