API

A typed API that integrates in an afternoon, not a sprint

REST and GraphQL endpoints for every platform action — so your tooling, scripts, and internal dashboards stay in control.

Abstract indigo diagram of REST API endpoint tree with floating JSON response cards

What the API gives you that the GUI can't

The Practice of Edinburgh API exposes every platform action that exists in the dashboard — and several that don't. You can trigger builds, promote environments, rotate secrets, query build metrics, and manage team permissions entirely from your own scripts or internal tooling. Every endpoint is versioned under /v1 and returns typed JSON with consistent error shapes, so error handling is predictable across every integration. We publish an OpenAPI 3.1 spec that you can import directly into Postman, Insomnia, or any code generator. SDK packages for TypeScript and Python are maintained by our core team and updated with every API release — not community-maintained afterthoughts.

What you can automate with the API

Real use cases from teams already using the Practice of Edinburgh API in production.

Custom deploy pipelines

Trigger a build, watch its status via a webhook, promote to production if checks pass — all from a GitHub Actions workflow or a plain shell script. No GUI clicks required in your critical path.

Internal dashboards

Pull live deploy cadence, build success rates, and environment uptime into your own Grafana or Retool dashboard. Your leadership gets the metrics they want without logging into another tool.

Secrets rotation

Rotate API keys and environment secrets programmatically on a schedule. Integrate with HashiCorp Vault or AWS Secrets Manager to keep credentials fresh without manual intervention or a deploy cycle.

OAuth token flow diagram between a developer machine, the Practice of Edinburgh API, and a cloud service

Authentication and rate limits — the numbers

All API requests authenticate with short-lived JWTs issued via your organization's OAuth provider or via a machine-token you generate in the dashboard. Tokens scope to individual resources — a deploy token for Service A cannot touch Service B, even within the same organization. Rate limits on the Start plan sit at 300 requests per minute per organization; Pro teams get 1,500 rpm; Enterprise contracts have no hard cap and negotiate SLAs directly. Webhooks deliver events within 500 ms of the triggering action under normal load. We publish a public status page with rolling 90-day uptime history for both the API and the webhook delivery system.

“We built a full internal deploy dashboard in Retool using the Practice of Edinburgh API in about four hours. The OpenAPI spec imported cleanly and the TypeScript SDK saved us at least a day of boilerplate. The rate limits on the Pro plan are more than enough for our team of 22.”

Leo Strauss, Platform Engineer, Chicago IL

Start calling the API today

Every trial account includes full API access. Generate your first token in under a minute.

Start free trial