Shipeasy

API reference

REST endpoints for feature flags, configs, killswitches, metrics, alerts and the ops queue — with live request samples in cURL, JavaScript, and Python.

The Admin API is the same surface the dashboard, CLI, and MCP server use. Every request:

  • authenticates with Authorization: Bearer sdk_admin_…
  • scopes to a project via X-Project-Id: <projectId>
  • speaks JSON, returns conventional HTTP status codes
curl https://shipeasy.ai/api/admin/gates \
  -H "Authorization: Bearer sdk_admin_..." \
  -H "X-Project-Id: prj_..."

Mint admin keys via POST /api/admin/keys with type: "admin". Keys expire after 90 days; rotate with the revoke action.

Common patterns

Pagination. List endpoints return { data: [...], next_cursor: "..." }. Pass ?cursor=<next_cursor> and ?limit=<n> to page.

Errors. All errors share a single envelope:

{ "error": { "code": "not_found", "message": "Gate 'foo' not found" } }

Idempotency. POST writes that create resources accept Idempotency-Key: <uuid> and replay the same response if you retry within 24h.

Was this page helpful?
Updated June 18, 2026✎ Edit this page