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

Xata Projects API

Operations for creating, retrieving, updating, and deleting projects within an organization

Xata Projects API is one of 12 APIs that Xata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 14 operations across 11 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://api.xata.tech.

14 operations 11 paths 14 schemas 1 DELETE11 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.xata.tech
Authentication
OpenID Connect, API Key, OAuth 2.0, API Key
Contact
help@xata.io
Resource Areas
1

Authentication & Security 4

Xata Projects API declares 4 security schemes for authenticating requests. It supports OpenID Connect (oidc) discovered at https://auth.xata.io/realms/xata/.well-known/openid-configuration. An API key is passed in the header as Authorization (apiKey). It supports OAuth 2.0 (xata) using the implicit flow, exposing 13 scopes. An API key is passed in the header as Connection-String (branchConnectionString).

  • apiKey — API key authentication using Bearer token format: Bearer
  • branchConnectionString — Branch PostgreSQL connection string (postgres://user:pass@{branch}.{region}.xata.tech/db), including the embedded password. The hostname selects the target bra…

Paths & Operations 14

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

Projects 14

Operations for creating, retrieving, updating, and deleting projects within an organization

GET
/organizations/{organizationID}/regions
Get available regions
listRegions 1 param → 2004004015XXdefault
GET
/organizations/{organizationID}/instanceTypes
Get available instance types
listInstanceTypes 2 params → 2004004015XXdefault
GET
/organizations/{organizationID}/images
Get available images
listImages 2 params → 2004004015XXdefault
GET
/organizations/{organizationID}/extensions
Get available extensions for image
listExtensions 3 params → 2004004015XXdefault
GET
/organizations/{organizationID}/limits
Get organization resource limits
getOrganizationLimits 1 param → 2004014035XX
GET
/organizations/{organizationID}/projects/limits
Get project resource limits
getDefaultProjectLimits 1 param → 200
GET
/organizations/{organizationID}/projects
List all projects
listProjects 1 param → 2004004015XXdefault
POST
/organizations/{organizationID}/projects
Create a new project
createProject 1 param body → 2014004015XXdefault
GET
/organizations/{organizationID}/projects/{projectID}
Get project details
getProject 2 params → 2004004014045XXdefault
PATCH
/organizations/{organizationID}/projects/{projectID}
Update project details
updateProject 2 params body → 2004004014045XXdefault
DELETE
/organizations/{organizationID}/projects/{projectID}
Delete a project
deleteProject 2 params → 2044004014045XXdefault
GET
/organizations/{organizationID}/projects/{projectID}/limits
Get project resource limits
getProjectLimits 2 params → 2004015XXdefault
GET
/organizations/{organizationID}/projects/{projectID}/backups
List project backups
listBackups 2 params → 2004004014045XXdefault
GET
/organizations/{organizationID}/projects/{projectID}/backups/{backupID}
Get project backup by ID
getBackup 3 params → 2004004014045XXdefault

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are EffectiveProjectLimits (6 properties), Extension (6 properties), BackupMetadata (5 properties), Project (5 properties). Each schema is shown below with its type and property counts.

OrganizationLimits
Effective resource limits for an organization, covering org-level defaults for all projects plus organization-specific constraints
EffectiveProjectLimits
object
Full set of resource limits applicable to a project and its branches
6 properties 6 required
Image
object
Details of a postgres image
4 properties 3 required
ProjectLimits
object
Resource limits and constraints for projects within an organization
4 properties 4 required
BackupMetadata
object
metadata about a continuous backup
5 properties 3 required
IPFilteringConfiguration
object
Configuration for IP filtering on project branches
2 properties 2 required
OrganizationID
string
ProjectConfiguration
object
Configuration details for a project, including its scale to zero settings
2 properties 1 required
Project
object
Details of a project including its ID, name, and creation/update timestamps
5 properties 5 required
Extension
object
Details of a postgres extension
6 properties 6 required
UpdateProjectConfiguration
object
Partial configuration update for a project
2 properties
CidrEntry
object
2 properties 1 required
ScaleToZeroConfiguration
object
Configuration for scaling branches to zero when not in use
2 properties 2 required
ProjectScaleToZeroConfiguration
object
Whether the project branches are configured to scale down to zero when not in use
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xata-projects-api-openapi.yml Raw ↑

Other APIs Xata publishes across the network.

Xata API Keys API
Xata Billing API
Xata Branches API
Xata Gateway API
Xata GitHub App API
Xata Logs API
Xata Marketplace API
Xata Metrics API
Xata Organizations API
Xata Projects Webhooks API
Xata Webhooks API