Overview
HTTP API for the Tektona platform.
The Tektona platform exposes a single HTTP API hosted at
https://api-dev.tektona.ai. Most control-plane endpoints are versioned under /v1 and
use API-key bearer authentication.
The reference below is generated from the platform's OpenAPI 3.1 specification
at https://api-dev.tektona.ai/openapi.json. You can also consume that spec directly to
generate a client in any language with openapi-generator, oapi-codegen,
etc.
Reaching the API
TypeScript SDK
Use @tektona/sdk for typed access from Node.js, Bun, Deno, or edge runtimes.
CLI
The tektona binary covers most operations from a shell.
Raw HTTP
Any HTTP client works. Every endpoint accepts JSON over HTTPS.
Authentication
Every request must carry an API key in the Authorization header:
Authorization: Bearer <api-key>Create a key from the Tektona console (Settings → API keys).
Keys are tied to your user account, not to an organization. The same key works against every org and project you have access to. Pass the target org and project via the path or request body for each operation (see the per-endpoint schemas below).
Rate limits
API requests are rate limited per authenticated principal (your user or API
key), with generous defaults that normal CLI, SDK, and automation traffic stays
well under. A separate, tighter budget applies to sandbox creation, which is
more expensive than a read, and requests are additionally limited per client IP
before authentication, so unauthenticated traffic is bounded too. Each response
advertises the relevant budgets as X-RateLimit-*-{throttler} headers, where
{throttler} is general, sandbox-create, or ip:
X-RateLimit-Limit-{throttler}— the request ceiling for the windowX-RateLimit-Remaining-{throttler}— requests left before you are throttledX-RateLimit-Reset-{throttler}— seconds until the budget refills
If you exceed a limit the API responds with 429 Too Many Requests and a
Retry-After header (seconds to wait before retrying), plus a throttler-suffixed
Retry-After-{throttler} identifying which budget was hit. Back off until then,
or key long-running workloads off the X-RateLimit-Remaining-{throttler} hint.
Browsing the reference
Endpoints are grouped by resource in the sidebar (Sandboxes, Projects, Registries, Egress Network Policies, Locations, and so on). Each operation page includes:
- The full path, method, and request/response schemas
- An interactive Send button to try the call live against
https://api-dev.tektona.ai - Copy-pasteable code snippets in cURL, JavaScript, Go, Python, Java, and C#
Versioning
The API is currently alpha. Endpoints, request shapes, and response
shapes can change between releases. Once it stabilizes, breaking changes
will move to a new path prefix (/v2, etc.) so existing clients keep
working.