Xata Gateway API
PostgreSQL connectivity via HTTP SQL, WebSocket wire protocol proxy, and native wire protocol.
Xata Gateway API is one of 12 APIs that Xata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Gateway. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 2 operations across 2 paths, and defines 6 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Xata Gateway 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: BearerbranchConnectionString— Branch PostgreSQL connection string (postgres://user:pass@{branch}.{region}.xata.tech/db), including the embedded password. The hostname selects the target bra…
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
PostgreSQL connectivity via HTTP SQL, WebSocket wire protocol proxy, and native wire protocol.
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (17 properties), FieldDefinition (7 properties), QueryResult (5 properties), SQLRequest (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Xata 11
Other APIs Xata publishes across the network.