APIFlow Systems

Documentation

Everything you need to ship against APIFlow

Base URL: https://api.apiflow.systems — all endpoints accept and return JSON over TLS 1.3, authenticate with Bearer tokens and follow consistent pagination, versioning and error conventions.

Browse the Reference Talk to Engineering

Quickstart

Live in four commands

1

apiflow login

Authenticate the CLI against your tenant.

2

apiflow import spec.yaml

Generate routes from your OpenAPI schema.

3

apiflow deploy --canary 5%

Push routes to the edge with canary traffic.

4

apiflow watch

Tail live metrics, traces and errors.

Gateway API

Create, inspect and retire routes on every gateway in your estate.

GET /v1/routes

List all active gateway routes with upstream targets, policies and live health status.

Bearer token p95 12 ms
POST /v1/routes

Create a route from a declarative definition. Validated against the schema before activation.

Bearer token p95 25 ms
PATCH /v1/routes/{id}

Update route matching, transforms or upstream weights. Hot-reloaded without dropping connections.

Bearer token p95 20 ms
DELETE /v1/routes/{id}

Retire a route gracefully: drain in-flight requests, then remove from all 31 edges.

Bearer token p95 14 ms

Keys & Authentication

Issue, rotate and revoke credentials; inspect quota usage per key.

POST /v1/keys

Issue a scoped API key bound to a gateway, environment and rate-limit plan.

Bearer token p95 18 ms
GET /v1/keys/{id}/usage

Retrieve per-key usage against its quota window, with projected exhaustion time.

Bearer token p95 16 ms
POST /v1/keys/{id}/rotate

Rotate a key with an overlap grace period so consumers can cut over safely.

Bearer token p95 21 ms
DELETE /v1/keys/{id}

Revoke an API key instantly across the entire edge fleet.

Bearer token + admin scope p95 9 ms

Policies

Manage rate limits and enforcement policies, with traffic dry-runs.

GET /v1/policies

List rate-limiting, auth and transform policies across all gateways and environments.

Bearer token p95 11 ms
PUT /v1/policies/{id}

Update a policy. Changes propagate to every edge location in under five seconds.

Bearer token p95 22 ms
POST /v1/policies/{id}/dry-run

Replay a policy against the last 24 hours of traffic and see exactly what it would have blocked.

Bearer token p95 180 ms

Monitoring

Pull metrics and traces, and manage alert routing.

GET /v1/metrics/traffic

Query traffic metrics by route, status class, region and time window at one-second granularity.

Bearer token p95 45 ms
GET /v1/traces/{id}

Fetch a stitched OpenTelemetry trace from client through gateway to upstream service.

Bearer token p95 60 ms
POST /v1/alerts

Create threshold or anomaly alert rules with routing to PagerDuty, Slack or email.

Bearer token p95 19 ms

Webhooks

Subscribe to lifecycle events with HMAC-signed deliveries.

POST /v1/webhooks

Register a webhook target for deployment, quota and incident events, signed with HMAC.

Bearer token p95 15 ms
GET /v1/webhooks/{id}/deliveries

Inspect delivery attempts, response codes and replay any failed delivery.

Bearer token p95 13 ms

Conventions

Boring APIs, on purpose

  • Versioned in the path (/v1) with published sunset headers
  • Cursor pagination on every list endpoint via ?cursor=
  • RFC 9457 problem+json error bodies with stable machine-readable codes
  • Idempotency keys honoured on all mutating requests
  • Rate-limit state in every response: X-RateLimit-* headers

SDKs & Tooling

Generated from the same schema

Official SDK packages
TypeScript / Node.js @apiflow/sdk
Python apiflow-sdk
Go github.com/apiflow/go-sdk
Java systems.apiflow:sdk
Ruby apiflow-sdk (gem)
CLI apiflow-cli (brew, apt, npm)

Cannot find what you need?

Our engineers answer documentation questions directly — no support tiers, no ticket triage. Ask us anything.

Explore the Platform Read Documentation View Integrations Talk to Engineering