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

Operations for retrieving log entries for a branch

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

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

This API exposes 1 operation across 1 path, 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.

1 operations 1 paths 6 schemas 1 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 Logs 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Logs 1

Operations for retrieving log entries for a branch

POST
/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/logs
Retrieve branch logs
branchLogs 3 params body → 2004004014045XXdefault

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are LogEntry (5 properties), BranchLogsRequest (5 properties), BranchLogs (4 properties), LogFilter (4 properties). Each schema is shown below with its type and property counts.

BranchLogsRequest
object
5 properties 2 required
LogLevel
string
Log level enumeration
OrganizationID
string
LogFilter
object
A single filter on log entries.
4 properties 2 required
LogEntry
object
5 properties 3 required
BranchLogs
object
A collection of logs for each of the instances of a branch
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xata-logs-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 Marketplace API
Xata Metrics API
Xata Organizations API
Xata Projects API
Xata Projects Webhooks API
Xata Webhooks API