API Reference

Authenticate and receive tokens

Complete Google, GitHub or Microsoft (azure) sign-in with an authorization code (?code=)

Create a new user account

Refresh access token

Invalidate session

Request email verification OTP

Validate OTP code

Initiate password reset

Complete password reset

Begin SAML SSO flow

Create organization

List the organizations you belong to

List cloud accounts

Connect cloud account

Get cloud account

Update cloud account

Delete cloud account

Get GCP OAuth URL

Exchange GCP OAuth code

Finalize GCP OAuth

List clusters in a cloud account

Register a cluster for kubeconfig access

Deregister a cluster

List resources with filtering

Count resources matching filters

Get resource detail

Get resources by IDs

Get resources by cloud UIDs (query)

Get resources by cloud UIDs (body)

Per-provider discovery rollup

Check IAM + network access to a managed Kubernetes cluster

Most recent discovery timestamp per provider/account

Get available filter options

Trigger discovery refresh

Check refresh status

List schedules

Create schedule

Get schedule

Update schedule

Delete schedule

Attach resource

Detach resource

Attach group

Detach group

List resource groups

Create resource group

Get resource group

Update resource group

Delete resource group

Get group schedules

Add member

Update execution order

Remove member

List overrides

Create override

Get override

Delete override

List group overrides

Create group override

Submit manual action

Submit bulk action

Get action status

Get bulk action status

Get the most recent bulk action

Get state history

Dashboard summary

Cost trends

Long-range cost history

Aggregate utilization metrics

Resource costs

Cost breakdown by dimensions (Sankey)

Provider summary

Resource summary

Per-resource utilization metrics

Live container state of a VM: scope=vm, optional container=<name>. source is backend or exec

Usage history for one VM container from the attached metrics backend: scope=vm, container=<name>, range=15m|1h|6h|24h. 404 without a backend; 409 backend_host_unresolvable when the host of the stored URL does not resolve

Log history for one VM container from the attached logs backend, newest first: scope=vm, container=<name>, range=15m|1h|6h|24h, limit (default 200, max 1000), optional q and cursor. Returns items, hasMore, nextCursor, provider. 404 without a logs backend; 409 backend_host_unresolvable when the host of the stored URL does not resolve

Traces for one VM container from the attached traces backend (Tempo, Jaeger or Zipkin), newest first: scope=vm, container=<name>, range=15m|1h|6h|24h, limit (default 20, max 100), optional q (span name) and cursor. Returns items (traceId, rootService, rootName, startTime, durationMs, spanCount, errorCount), hasMore, nextCursor, provider. 409 traces_not_configured without a traces backend; 409 backend_host_unresolvable when the host of the stored URL does not resolve

One trace's spans for one VM container from the attached traces backend: scope=vm, container=<name>. Returns traceId, provider and spans (spanId, parentSpanId, name, service, kind, startTime, durationMs, status, attributes). 404 when the trace has none of the container's spans; 409 traces_not_configured without a traces backend

Per-resource activity timeline

Monthly snapshots

List anomaly records

Export a report as CSV/JSON

Cost per team

Team breakdown

Per-resource cost for a team

Team cost trends

Tag keys with attributed cost

Tag values for a key

Resources by tag

Tag cost trends

Budget summary

List budgets

Create budget

Update budget

Delete budget

List scheduler events

Record scheduler event

Current foreign-exchange rates used by reports

Billing sync status for every cloud account in the org

Verify billing access for one cloud account. Body: {cloudAccountId, provider}

List resources with recommendation summaries

List rules with recommendation summaries

List individual recommendations

Recommendation summary

Provider breakdown

Get available filter fields

Resource recommendations (deprecated)

Recommendation detail

Update recommendation

Refresh recommendations

List derived/accepted virtual tags + org-wide counts

Accept or revoke tags (body: resourceUid, keys, all, accepted)

Tagging-policy form vocabulary

Validate a tagging-policy spec before create

List autoscaler policies

Create policy

Count policies by status

Distinct filter values

Smart defaults for a target

Inspect the scaling policies already configured on a target in your cloud account

IAM permissions to provision infra

Provision autoscaler infrastructure

Provisioning status for a cloud account

Get policy

Update policy

Delete policy

Apply latest recommendation

Pause evaluation

Resume evaluation

Soft-delete the policy

Per-policy event log

List plans

Create a plan

Preview scaled capacity

Preview database tier change

Preview a full plan without saving

Count plans

Filter values

Get a plan

Update a plan

Delete a plan

Estimated DB impact

Estimated extra cost

Re-validate the plan

Dispatch the plan to executor

Cancel an active plan

Plan audit log

List dashboards (system presets + user-created)

Create a dashboard

Get a dashboard

Update a dashboard

Delete a dashboard

Set the org default dashboard

List notifications (legacy)

Create notification (legacy)

Update notification (legacy)

Delete notification (legacy)

List notification channels

Create notification channel

Update notification channel

Delete notification channel

List subscriptions

Create subscription

Update subscription

Delete subscription

Bulk create/update subscriptions

List event types

Get email preferences

Update email preference

Share recommendation

Test channel delivery

List users

Invite user

Update user

Remove user

List teams

Create team

Get team

Update team

Delete team

List team members

Add team member. Body: {email, roleId}

Change a member's team role. Body: {roleId}

Remove team member

List team resources

Assign resource to team

Unassign a resource. Body: {resourceUid}

List roles

Create role

Get role

Update role

Delete role

List policies

List role assignments

Create assignment

Update assignment

Delete assignment

Get current user permissions

Get user permissions

Verify permission

List organizations

Create organization

List the organizations you belong to

Get current organization

Update organization

Delete organization

List audit logs

Export audit logs as CSV

List deployment spaces

Register an existing cluster as a space

Get a space

Toggle a space active/inactive

Update the space config, e.g. { config: { observability: { metrics: '<integrationID>' | null, logs: '<integrationID>' | null, traces: '<integrationID>' | null } } } to attach or detach a metrics, logs or traces backend

Install or re-apply a cluster or VM component, e.g. { spaceId, targetType: 'vm', component: 'observability-agent' }. Returns an actionId to poll

List the component catalog (?targetType=) or poll an install (?actionId=)

Delete a space

List namespaces on a space’s cluster

Create a namespace on a space’s cluster

List clusters discovered on a cloud account

Register cluster access for kubeconfig minting

Deregister cluster access

Create a provisioning job

List provisioning jobs

Get a job

Update lightweight job fields

Delete a job

Retry a failed job

Create a database on the parent datastore

List databases

Get a database

Delete a database

Create a job-scoped connection

List job-scoped connections

Get a job-scoped connection

Delete a job-scoped connection

Create a database-scoped connection

List database-scoped connections

Get a database-scoped connection

Delete a database-scoped connection

Preview the remediation workflow for a recommendation

Start the remediation workflow for a recommendation

List workflow steps waiting for approval

List workflow steps waiting for confirmation

Get a workflow and its steps

Cancel a running workflow

Approve, reject or advance a step. Body: {action: approve | reject | advance}

List deployments

Create a deployment

Get a deployment

Delete a deployment and tear down what it runs

Update configs (creates a revision on next deploy)

Persist canvas (x, y) coordinate

Re-run deploy-readiness checks

Create a revision

List revisions

Get a revision

Roll back to a prior revision

Deployment event timeline

LoadBalancer status

List deployments in env

Create deployment in env

Analyze a repo for deploy readiness (wizard pre-create)

List connected repositories

List branches in a repository. Connected: integrationId + repo. Public: repoUrl (github.com only)

Create a project

List projects

Batch project stats (env count, status buckets)

Get a project

Update a project

Delete a project

Create environment

List environments

Get env (nested)

Update env

Delete env

Get env (flat lookup)

Live cluster discovery (ingress + cert-manager)

List integrations

Create an integration

Observability backends only: run the write/read connection probe against the given backend without saving it

Get an integration

Update an integration

Delete an integration

Begin GitHub App install flow. Optional ?role=read|write selects the App to install (write for IaC-CI orgs; defaults to read)

GitHub install/OAuth callback

GitHub event delivery (HMAC-signed; duplicate deliveries are ignored)

Build runner reports image readiness (authenticated by the callback JWT in the body)