/
CT
ctrlplanedev
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Resources
9
Variable Sets
5
Workflows
8
get
/v1/workspaces/{workspaceId}/workflows
List workflows
post
/v1/workspaces/{workspaceId}/workflows
Create a workflow
get
/v1/workspaces/{workspaceId}/workflows/slug/{slug}
Get a workflow by slug
post
/v1/workspaces/{workspaceId}/workflows/slug/{slug}/runs
Create a workflow run by slug
get
/v1/workspaces/{workspaceId}/workflows/{workflowId}
Get a workflow
put
/v1/workspaces/{workspaceId}/workflows/{workflowId}
Update a workflow
delete
/v1/workspaces/{workspaceId}/workflows/{workflowId}
Delete a workflow
post
/v1/workspaces/{workspaceId}/workflows/{workflowId}/runs
Create a workflow run
Workspaces
6
get
/v1/workspaces/{workspaceId}/deployment-variable-values/{valueId}
Get deployment variable value
put
/v1/workspaces/{workspaceId}/deployment-variable-values/{valueId}
Upsert deployment variable value
delete
/v1/workspaces/{workspaceId}/deployment-variable-values/{valueId}
Delete deployment variable value
get
/v1/workspaces/{workspaceId}/deployment-variables/{variableId}
Get deployment variable
put
/v1/workspaces/{workspaceId}/deployment-variables/{variableId}
Upsert deployment variable
delete
/v1/workspaces/{workspaceId}/deployment-variables/{variableId}
Delete deployment variable
get
/v1/workspaces/{workspaceId}/deployment-versions/{deploymentVersionId}/dependencies
List deployment-version dependencies
put
/v1/workspaces/{workspaceId}/deployment-versions/{deploymentVersionId}/dependencies/{dependencyDeploymentId}
Upsert deployment-version dependency
delete
/v1/workspaces/{workspaceId}/deployment-versions/{deploymentVersionId}/dependencies/{dependencyDeploymentId}
Delete deployment-version dependency
put
/v1/workspaces/{workspaceId}/deployment-versions/{deploymentVersionId}/user-approval-records
Upsert user approval record
get
/v1/workspaces/{workspaceId}/deployments
List deployments
post
/v1/workspaces/{workspaceId}/deployments
Create deployment
get
/v1/workspaces/{workspaceId}/deployments/name/{name}
Get deployment by name
get
/v1/workspaces/{workspaceId}/deployments/{deploymentId}
Get deployment
put
/v1/workspaces/{workspaceId}/deployments/{deploymentId}
Upsert deployment
delete
/v1/workspaces/{workspaceId}/deployments/{deploymentId}
Delete deployment
post
/v1/workspaces/{workspaceId}/deployments/{deploymentId}/plan
Create a deployment plan
get
/v1/workspaces/{workspaceId}/deployments/{deploymentId}/plan/{planId}
Get deployment plan
get
/v1/workspaces/{workspaceId}/deployments/{deploymentId}/variables
List deployment variables by deployment
get
/v1/workspaces/{workspaceId}/deployments/{deploymentId}/versions
List deployment versions
post
/v1/workspaces/{workspaceId}/deployments/{deploymentId}/versions
Create a deployment version
patch
/v1/workspaces/{workspaceId}/deploymentversions/{deploymentVersionId}
Update deployment version
get
/v1/workspaces/{workspaceId}/environments
List environments
post
/v1/workspaces/{workspaceId}/environments
Create environment
get
/v1/workspaces/{workspaceId}/environments/name/{name}
Get environment by name
get
/v1/workspaces/{workspaceId}/environments/{environmentId}
Get environment
put
/v1/workspaces/{workspaceId}/environments/{environmentId}
Upsert environment
delete
/v1/workspaces/{workspaceId}/environments/{environmentId}
Delete environment
get
/v1/workspaces/{workspaceId}/job-agents
List job agents
get
/v1/workspaces/{workspaceId}/job-agents/{jobAgentId}
Get a job agent
put
/v1/workspaces/{workspaceId}/job-agents/{jobAgentId}
Upsert a job agent
delete
/v1/workspaces/{workspaceId}/job-agents/{jobAgentId}
Delete a job agent
get
/v1/workspaces/{workspaceId}/job-agents/{jobAgentId}/jobs
List jobs for a job agent
post
/v1/workspaces/{workspaceId}/job-agents/{jobAgentId}/jobs/{jobId}/claim
Claim a job
get
/v1/workspaces/{workspaceId}/jobs
List jobs
get
/v1/workspaces/{workspaceId}/jobs/{jobId}
Get job
put
/v1/workspaces/{workspaceId}/jobs/{jobId}/status
Update job status
get
/v1/workspaces/{workspaceId}/jobs/{jobId}/with-release
Get job with release
get
/v1/workspaces/{workspaceId}/policies
List policies
post
/v1/workspaces/{workspaceId}/policies
Create a policy
get
/v1/workspaces/{workspaceId}/policies/{policyId}
Get a policy by ID
put
/v1/workspaces/{workspaceId}/policies/{policyId}
Upsert a policy by ID
delete
/v1/workspaces/{workspaceId}/policies/{policyId}
Delete a policy by ID
get
/v1/workspaces/{workspaceId}/relationship-rules
Get relationship rules for a given workspace
post
/v1/workspaces/{workspaceId}/relationship-rules
Create relationship rule
get
/v1/workspaces/{workspaceId}/relationship-rules/{relationshipRuleId}
Get relationship
put
/v1/workspaces/{workspaceId}/relationship-rules/{relationshipRuleId}
Upsert relationship
delete
/v1/workspaces/{workspaceId}/relationship-rules/{relationshipRuleId}
Delete relationship
post
/v1/workspaces/{workspaceId}/release-targets/resource-preview
Preview release targets for a resource
post
/v1/workspaces/{workspaceId}/release-targets/state
Get release target states by deployment and environment
get
/v1/workspaces/{workspaceId}/release-targets/{releaseTargetKey}/desired-release
Get the desired release for a release target
post
/v1/workspaces/{workspaceId}/release-targets/{releaseTargetKey}/eligible-versions
List versions eligible for a release target
get
/v1/workspaces/{workspaceId}/release-targets/{releaseTargetKey}/jobs
Get jobs for a release target
get
/v1/workspaces/{workspaceId}/release-targets/{releaseTargetKey}/state
Get the state for a release target
get
/v1/workspaces/{workspaceId}/releases/{releaseId}
Get release
put
/v1/workspaces/{workspaceId}/resource-providers
Upsert resource provider
get
/v1/workspaces/{workspaceId}/resource-providers/name/{name}
Get a resource provider by name
delete
/v1/workspaces/{workspaceId}/resource-providers/name/{name}
Delete a resource provider by name
get
/v1/workspaces/{workspaceId}/resource-providers/name/{name}/resources
Get the resources for a resource provider
put
/v1/workspaces/{workspaceId}/resource-providers/{providerId}/set
Set the resources for a provider
get
/v1/workspaces/{workspaceId}/systems
List systems
post
/v1/workspaces/{workspaceId}/systems
Create system
get
/v1/workspaces/{workspaceId}/systems/{systemId}
Get system
put
/v1/workspaces/{workspaceId}/systems/{systemId}
Upsert system
delete
/v1/workspaces/{workspaceId}/systems/{systemId}
Delete system
get
/v1/workspaces/{workspaceId}/systems/{systemId}/deployments/{deploymentId}
Get deployment system link
put
/v1/workspaces/{workspaceId}/systems/{systemId}/deployments/{deploymentId}
Link deployment to system
delete
/v1/workspaces/{workspaceId}/systems/{systemId}/deployments/{deploymentId}
Unlink deployment from system
get
/v1/workspaces/{workspaceId}/systems/{systemId}/environments/{environmentId}
Get environment system link
put
/v1/workspaces/{workspaceId}/systems/{systemId}/environments/{environmentId}
Link environment to system
delete
/v1/workspaces/{workspaceId}/systems/{systemId}/environments/{environmentId}
Unlink environment from system
Workflows
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Get a workflow by slug
get
/v1/workspaces/{workspaceId}/workflows/slug/{slug}
May 14, 2026
8881c619a52a
Revision changes
info
endpoint added