API
API reference
The REST API, grouped the way the OpenAPI document tags it. Each page lists its operations with method, path and who may call them.
- Base path
- /api/v1 (account routes under /api)
- Areas
- 27
- Operations
- 106
- Applications26 opsApplications and their sub-resources: validation, Pipeline copy, Permissions, Extended resources, Quotas, Ownership and chart values.
- Pipelines5 opsThe CI/CD definitions that build and ship an Application.
- Pipeline runs5 opsExecutions of a Pipeline, with status from NOT_STARTED to SUCCEEDED, FAILED or CANCELED.
- Deployments5 opsRunning instances of an Application on a Cluster, with service type and DNS.
- Events4 opsActivity records from delivery sources, linked to an Application or Pipeline.
- Clusters3 opsThe named Kubernetes Clusters that Deployments run on and Quotas are measured against.
- Cluster details1 opsPer-Cluster detail for the Cluster list.
- Commit statuses3 opsStatus checks on a repository commit, keyed by owner, repo, sha and context.
- Stages5 opsThe steps of a Deployment’s progress, each with its own status.
- Search1 opsOne lookup across Applications, Pipelines, Deployments, Events, Extended resources, Agents, Processes and MCP servers.
- Agents6 opsAgent definitions and Invoke. An Idempotency-Key header makes a repeated Invoke return the existing Agent run.
- Agent runs1 opsThe record of one Invoke: input, output, status and token usage.
- Processes6 opsMulti-agent templates of Steps under one Topology, and starting a Process run.
- Process runs1 opsOne execution of a Process, with its current Step and status.
- Approvals2 opsPending decisions raised by Approval gates, and approving or rejecting them.
- MCP servers5 opsThe governed registry of Model Context Protocol tool servers Agents may use.
- Yellow Pages lookup1 opsSearch the Yellow Pages catalog from inside Helmsman.
- VCS tenants1 opsVersion-control organizations and groups mirrored read-only from Yellow Pages.
- Push tokens2 opsRegister and remove the mobile app’s push token for Approval notifications.
- EULA2 opsThe current EULA version and the caller’s acceptance of it.
- Content reports3 opsReport an Application, Agent or Process as objectionable, and work the review queue.
- Blocks3 opsHide another user’s content from your own lists. Never affects Approvals or runs.
- Me1 opsThe signed-in caller’s own identity, Organizations and roles.
- Users3 opsOrganization members, pending sign-ups and Org role changes.
- Service accounts3 opsNon-human identities and their PATs.
- Organizations6 opsThe caller’s Organizations, their SSO and AI review settings, and Eject.
- Directory2 opsTeams and people from the configured directory provider, for owner pickers.