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 API Keys API

Operations for managing API keys, including creation, listing, and deletion

Xata API Keys API is one of 12 APIs that Xata 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 6 operations across 2 paths, and defines 4 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.

6 operations 2 paths 4 schemas 2 DELETE2 GET2 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 API Keys 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 6

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

API Keys 6

Operations for managing API keys, including creation, listing, and deletion

GET
/organizations/{organizationID}/api-keys
List API Keys for an organization
listOrganizationAPIKeys 1 param → 2004004014034045XX
POST
/organizations/{organizationID}/api-keys
Create an Organization API Key
createOrganizationAPIKey 1 param body → 201400
DELETE
/organizations/{organizationID}/api-keys
Bulk delete API Keys for an organization
deleteOrganizationAPIKeys 1 param body → 204400401404
GET
/api-keys
List API Keys for the authenticated user
listUserAPIKeys → 2004004015XX
POST
/api-keys
Create a User API Key
createUserAPIKey body → 2014004015XX
DELETE
/api-keys
Bulk delete API Keys for the authenticated user
deleteUserAPIKeys body → 2044004014045XX

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are FullAPIKey (12 properties), APIKeyPreview (11 properties), CreateAPIKeyRequest (5 properties). Each schema is shown below with its type and property counts.

OrganizationID
string
CreateAPIKeyRequest
object
5 properties 1 required
FullAPIKey
object
12 properties 10 required
APIKeyPreview
object
11 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Xata publishes across the network.

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 API
Xata Projects Webhooks API
Xata Webhooks API