Overview

RouteSeam API 1.0.0

Public RouteSeam API — the source of truth for the /api/v1 surface served by the Rails control plane. This spec documents what the controllers and serializers ACTUALLY implement today; keep it in lockstep with web/app/controllers/api/v1 and web/app/serializers/api/v1.

Future SDKs, the CLI, and the Terraform provider are GENERATED from this file (prd.md §44) — hand-maintained client code is the thing we avoid.

Auth: X-Api-Key header (rs_live_… keys from Settings → API Keys). Rate limit: 300 requests/minute per key (shared across all v1 endpoints). API access requires a paid plan.

Information

• OpenAPI version: 3.1.0

Operations

GET

/api/v1/domains

POST

/api/v1/domains

GET

/api/v1/domains/{id}

DELETE

/api/v1/domains/{id}

PATCH

/api/v1/domains/{id}

GET

/api/v1/domains/{domain_id}/route

PATCH

/api/v1/domains/{domain_id}/route

GET

/api/v1/domains/{domain_id}/analytics

Authentication

ApiKeyAuth

Rs_live_… key (Settings → API Keys). Hashed at rest; shown once.

Security scheme type: apiKey

Header parameter name: X-Api-Key