API documentation

Use the Cynone API to inspect projects, resources, deployments, and operational state from your own tooling. User-created profile tokens are read-only and scoped to the team selected when the token is created.

OpenAPI JSON OpenAPI YAML

Authentication

After signing in, create a token from Profile, API Tokens. Send it with each request as a bearer token.

curl -H "Authorization: Bearer $CYNONE_TOKEN" \
  "$CYNONE_URL/api/v1/projects"

Project scope

Tokens include the current team id. Project endpoints only return projects from that token team, so a token created in one workspace cannot list another workspace's projects.

GET /api/v1/projects
GET /api/v1/projects/{uuid}
GET /api/v1/projects/{uuid}/environments