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

The Filter API from Hatchet — 2 operation(s) for filter.

Hatchet Filter 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 Filter. 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 5 operations across 2 paths, and defines 8 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.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 PATCH1 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 Filter 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 5

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

Filter 5
GET
/api/v1/stable/tenants/{tenant}/filters
List Filters
v1-filter:list 5 params → 200400403
POST
/api/v1/stable/tenants/{tenant}/filters
Create a Filter
v1-filter:create 1 param body → 200400403404
GET
/api/v1/stable/tenants/{tenant}/filters/{v1-filter}
Get a Filter
v1-filter:get 2 params → 200400403
DELETE
/api/v1/stable/tenants/{tenant}/filters/{v1-filter}
Delete a filter
v1-filter:delete 2 params → 200400403404
PATCH
/api/v1/stable/tenants/{tenant}/filters/{v1-filter}
Update a filter
v1-filter:update 2 params body → 200400403404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are V1Filter (7 properties), V1CreateFilterRequest (4 properties), APIError (4 properties), PaginationResponse (3 properties). Each schema is shown below with its type and property counts.

PaginationResponse
object
3 properties
V1UpdateFilterRequest
object
3 properties
V1CreateFilterRequest
object
4 properties 3 required
APIResourceMeta
object
3 properties 3 required
V1Filter
object
7 properties 6 required
APIErrors
object
1 property 1 required
V1FilterList
object
2 properties
APIError
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hatchet-filter-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 Github API
Hatchet Healthcheck API
Hatchet Log API
Hatchet Metadata API
Hatchet Monitoring API
Hatchet Observability API
Hatchet Rate Limits API