/

/portal API

Changes Docs Sign in

Docs
History
Schema

Filter operations

get/healthApp-level health surface the UI reads
get/auth/githubStart the GitHub OAuth flow (browser redirect)
get/auth/github/callbackGitHub OAuth callback (browser redirect)
post/auth/handoffExchange the HttpOnly login-handoff cookie for the JWT (one-time)
get/auth/meThe authenticated user
post/webhooks/githubGitHub push webhook (public, HMAC-verified)
get/usersList org users (admin)
put/users/{userId}/roleChange a user's role (owner)
get/audit-logsList audit logs (admin)
get/variablesList org variables
post/variablesCreate an org variable (admin)
put/variables/{variableId}Update an org variable (admin)
delete/variables/{variableId}Delete an org variable (admin)
get/variables/{variableId}/valueReveal an org variable's decrypted value (admin)
get/teamsList teams
post/teamsCreate a team (admin)
get/teams/{teamId}Get a team
delete/teams/{teamId}Delete a team (admin)
get/teams/{teamId}/membersList team members
post/teams/{teamId}/membersAdd a team member (admin)
put/teams/{teamId}/members/{userId}Update a team member (admin)
delete/teams/{teamId}/members/{userId}Remove a team member (admin)
get/accountsList AWS accounts (admin)
post/accountsRegister an AWS account (admin)
get/accounts/{accountId}Get an account (admin)
put/accounts/{accountId}Update an account (admin)
delete/accounts/{accountId}Delete an account (admin)
get/clustersList clusters
post/clustersRegister a cluster (admin)
get/clusters/{clusterId}Get a cluster
put/clusters/{clusterId}Update a cluster (admin)
delete/clusters/{clusterId}Delete a cluster (admin)
post/clusters/{clusterId}/test-connectionRe-run the async connection test (admin)
get/cluster-ordersRecent cluster operations across the org (admin)
post/cluster-ordersOrder a cluster vend (admin)
delete/cluster-orders/{environment}/{name}Order a cluster teardown (admin)
get/cluster-orders/{environment}/{name}/operationsVend log for one cluster, newest first (admin)
post/cluster-orders/{environment}/{name}/unwedgeBreak-glass teardown for a wedged spoke (owner)
get/ops/feedOrg-wide operations feed (admin)
get/templatesList tenant templates
post/templatesCreate a template (admin)
get/templates/{templateID}Get a template
put/templates/{templateID}Update a template (admin)
delete/templates/{templateID}Delete a template (admin)
get/templates/{templateID}/accessList team-access grants on a template
post/templates/{templateID}/accessGrant a team access to a template (admin)
delete/templates/{templateID}/access/{teamId}Revoke a team's template access (admin)
get/tenantsList tenants (watcher-observed inventory)
post/tenantsRequest a tenant deploy (operator)
get/tenants/{tenantId}Get a tenant
delete/tenants/{tenantId}Request a tenant delete (operator)
get/tenants/{tenantId}/operationsPer-tenant operation log
get/tenants/{tenantId}/accessList team-access grants on a tenant
post/tenants/{tenantId}/accessGrant a team access to a tenant (admin)
delete/tenants/{tenantId}/access/{teamId}Revoke a team's tenant access (admin)
get/pipelinesList pipelines
post/pipelinesCreate a pipeline (operator; a stage auto_apply on a gated workspace needs admin)
get/pipelines/{pipelineId}Get a pipeline with its stages
put/pipelines/{pipelineId}Update a pipeline (operator; a stage auto_apply on a gated workspace needs admin)
delete/pipelines/{pipelineId}Delete a pipeline (admin)
get/pipelines/{pipelineId}/runsList pipeline runs
post/pipelines/{pipelineId}/runsStart a pipeline run (operator)
get/pipelines/{pipelineId}/runs/{runId}Get a pipeline run with its stage progress
post/pipelines/{pipelineId}/runs/{runId}/cancelCancel a pipeline run (operator)
get/pipelines/{pipelineId}/variablesList pipeline variables
post/pipelines/{pipelineId}/variablesCreate a pipeline variable (admin)
put/pipelines/{pipelineId}/variables/{variableId}Update a pipeline variable (admin)
delete/pipelines/{pipelineId}/variables/{variableId}Delete a pipeline variable (admin)
get/pipelines/{pipelineId}/variables/{variableId}/valueReveal a pipeline variable's decrypted value (admin)
get/workspacesList workspaces
post/workspacesCreate a workspace (operator; auto_apply needs admin)
get/workspaces/{workspaceId}Get a workspace
put/workspaces/{workspaceId}Update a workspace (operator; turning auto_apply on or requires_approval off needs admin)
delete/workspaces/{workspaceId}Delete a workspace (admin on the workspace; deleting the last workspace requiring approval on a repository + working directory needs org admin)
post/workspaces/{workspaceId}/uploadUpload a configuration archive (operator)
post/workspaces/{workspaceId}/cloneClone a workspace with its variables (operator; an auto-applying source needs admin)
post/workspaces/{workspaceId}/lockLock a workspace (operator)
post/workspaces/{workspaceId}/unlockUnlock a workspace (operator)
get/workspaces/{workspaceId}/variablesList workspace variables
post/workspaces/{workspaceId}/variablesCreate a workspace variable (admin)
get/workspaces/{workspaceId}/variables/effectiveMerged org → pipeline → workspace variable view
post/workspaces/{workspaceId}/variables/discoverDiscover the config's variable surface (viewer)
post/workspaces/{workspaceId}/variables/bulkCreate up to 50 variables in one call (admin)
post/workspaces/{workspaceId}/variables/import-outputsImport another workspace's outputs as variables (admin on both workspaces)
post/workspaces/{workspaceId}/variables/copyCopy another workspace's variables into this one (admin on both workspaces)
put/workspaces/{workspaceId}/variables/{variableId}Update a workspace variable (admin)
delete/workspaces/{workspaceId}/variables/{variableId}Delete a workspace variable (admin)
get/workspaces/{workspaceId}/variables/{variableId}/valueReveal a workspace variable's decrypted value (admin)
get/workspaces/{workspaceId}/stateList state versions
get/workspaces/{workspaceId}/state/currentThe latest state version
get/workspaces/{workspaceId}/state/current/resourcesParsed resources from the latest state
get/workspaces/{workspaceId}/state/current/outputsParsed outputs from the latest state
get/workspaces/{workspaceId}/state/diffDiff two state versions by serial
get/workspaces/{workspaceId}/state/{stateId}Get a state version
get/workspaces/{workspaceId}/state/{stateId}/downloadDownload the raw tfstate blob (admin)
delete/workspaces/{workspaceId}/state/serial/{serial}Drop one state version + its S3 objects (admin)
get/workspaces/{workspaceId}/accessList team-access grants on a workspace
post/workspaces/{workspaceId}/accessGrant/replace a team's workspace access (admin)
delete/workspaces/{workspaceId}/access/{teamId}Revoke a team's workspace access (admin)
get/workspaces/{workspaceId}/runsList a workspace's runs
post/workspaces/{workspaceId}/runsCreate a run (role elevates per operation; apply/destroy on a workspace that requires approval needs admin)

Changes to Diff two state versions by serial

get/workspaces/{workspaceId}/state/diff

Jul 22, 20268fb3292d26d8 Revision changes
- info
  added the optional property // to the response with the status