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

Hatchet Tenant API

The Tenant API from Hatchet — 15 operation(s) for tenant.

Hatchet Tenant API is one of 27 APIs that Hatchet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 12 JSON Schema definitions.

Tagged areas include Tenant. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, code examples, authentication docs, and 12 JSON Schemas.

This API exposes 20 operations across 15 paths, and defines 32 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against the base URL https://api.hatchet-cloud.run.

20 operations 15 paths 32 schemas 2 DELETE10 GET3 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.hatchet-cloud.run
Authentication
HTTP Bearer, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Hatchet Tenant API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the cookie as hatchet (cookieAuth). It accepts HTTP bearer tokens (customAuth). By default, every request must be authenticated.

Paths & Operations 20

Across 15 paths, the API surfaces 20 operations — 2 DELETE, 10 GET, 3 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Tenant 20
POST
/api/v1/tenants/{tenant}/alerting-email-groups
Create Tenant Alert Email Group
alert-email-group:create 1 param body → 201400403
GET
/api/v1/tenants/{tenant}/alerting-email-groups
List Tenant Alert Email Groups
alert-email-group:list 1 param → 200400403
GET
/api/v1/tenants/{tenant}/resource-policy
Create Tenant Alert Email Group
tenant-resource-policy:get 1 param → 200400403
PATCH
/api/v1/alerting-email-groups/{alert-email-group}
Update Tenant Alert Email Group
alert-email-group:update 1 param body → 200400403
DELETE
/api/v1/alerting-email-groups/{alert-email-group}
Delete Tenant Alert Email Group
alert-email-group:delete 1 param → 204400403
GET
/api/v1/users/invites
List Tenant Invites
user:list:tenant-invites → 200400403
POST
/api/v1/users/invites/accept
Accept Tenant Invite
tenant-invite:accept body → 200400403
POST
/api/v1/users/invites/reject
Reject Tenant Invite
tenant-invite:reject body → 200400403
POST
/api/v1/tenants
Create Tenant
tenant:create body → 200400403
PATCH
/api/v1/tenants/{tenant}
Update Tenant
tenant:update 1 param body → 200400403
GET
/api/v1/tenants/{tenant}
Get Tenant
tenant:get 1 param → 200400403404
GET
/api/v1/tenants/{tenant}/alerting/settings
Get Tenant Alerting Settings
tenant-alerting-settings:get 1 param → 200400403
POST
/api/v1/tenants/{tenant}/invites
Create Tenant Invite
tenant-invite:create 1 param body → 201400403422
GET
/api/v1/tenants/{tenant}/invites
List Tenant Invites
tenant-invite:list 1 param → 200400403
GET
/api/v1/tenants/{tenant}/step-run-queue-metrics
Get Step Run Metrics
tenant:get:step-run-queue-metrics 1 param → 200400403404
GET
/api/v1/tenants/{tenant}/members
List Tenant Members
tenant-member:list 1 param → 200400403
PATCH
/api/v1/tenants/{tenant}/members/{member}
Update a Tenant Member
tenant-member:update 2 params body → 200400403404
DELETE
/api/v1/tenants/{tenant}/members/{member}
Delete a Tenant Member
tenant-member:delete 2 params → 204400403404
GET
/api/v1/tenants/{tenant}/prometheus-metrics
Get Prometheus Metrics
tenant:get:prometheus-metrics 1 param → 200400403404
GET
/api/v1/tenants/{tenant}/task-stats
Get Task Stats for Tenant
tenant:get:task-stats 2 params → 200400403404

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Tenant (9 properties), UpdateTenantRequest (8 properties), TenantResourceLimit (7 properties), TenantAlertingSettings (7 properties). Each schema is shown below with its type and property counts.

TenantResource
string
TenantEnvironment
string
TenantAlertingSettings
object
7 properties 2 required
TenantMemberRole
string
Tenant
object
9 properties 4 required
APIResourceMeta
object
3 properties 3 required
TaskStats
object
APIError
object
4 properties 1 required
TenantMemberList
object
2 properties
PaginationResponse
object
3 properties
UpdateTenantMemberRequest
object
1 property 1 required
AcceptInviteRequest
object
1 property 1 required
UpdateTenantRequest
object
8 properties
TenantResourcePolicy
object
1 property 1 required
TaskStat
object
2 properties
TenantAlertEmailGroup
object
2 properties 2 required
TenantAlertEmailGroupList
object
2 properties
TenantResourceLimit
object
7 properties 5 required
CreateTenantInviteRequest
object
2 properties 2 required
CreateTenantAlertEmailGroupRequest
object
1 property 1 required
CreateTenantRequest
object
5 properties 2 required
APIErrors
object
1 property 1 required
TenantVersion
string
UserTenantPublic
object
2 properties 1 required
TaskStatusStat
object
4 properties
TenantInviteList
object
2 properties
TenantInvite
object
6 properties 5 required
TenantMember
object
4 properties 3 required
TenantStepRunQueueMetrics
object
1 property
UpdateTenantAlertEmailGroupRequest
object
1 property 1 required
ConcurrencyStat
object
3 properties
RejectInviteRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hatchet-tenant-api-openapi.yml Raw ↑

Other APIs Hatchet publishes across the network.

Hatchet API Token API
Hatchet CEL API
Hatchet Durable Tasks API
Hatchet Event API
Hatchet Feature Flags API
Hatchet Filter API
Hatchet Github API
Hatchet Healthcheck API
Hatchet Log API
Hatchet Metadata API
Hatchet Monitoring API
Hatchet Observability API