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

Estuary Tenants API

The Tenants API from Estuary — 3 operation(s) for tenants.

Estuary Tenants API is one of 8 APIs that Estuary publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.estuary.dev.

3 operations 3 paths 4 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.estuary.dev
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Estuary Tenants API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Access token obtained from /rpc/generateaccesstoken by exchanging a refresh token. Sent as Authorization: Bearer .

Paths & Operations 3

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

Tenants 3
GET
/tenants
List tenants (billing/ownership prefixes) the user can access.
listTenants → 200
GET
/catalog_stats
Read usage statistics (bytes and docs) per catalog entity and grain.
listCatalogStats 2 params → 200
POST
/rpc/billing_report_202308
Compute the monthly billing estimate for a tenant.
billingReport body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are CatalogStat (7 properties), Tenant (5 properties), BillingReport (5 properties), BillingReportRequest (2 properties). Each schema is shown below with its type and property counts.

BillingReportRequest
object
2 properties 2 required
CatalogStat
object
7 properties
BillingReport
object
5 properties
Tenant
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

estuary-tenants-api-openapi.yml Raw ↑

Other APIs Estuary publishes across the network.

Estuary Auth API
Estuary Captures API
Estuary Collections API
Estuary Connectors API
Estuary Drafts API
Estuary Materializations API
Estuary Publications API