/
CT
ctrlplanedev
/
Ctrlplane API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 1h ago · Updated 1mo ago
Details
Filter operations
Resources
7
Workflows
5
Workspaces
6
get
Get deployment variable value
put
Upsert deployment variable value
delete
Delete deployment variable value
get
Get deployment variable
put
Upsert deployment variable
delete
Delete deployment variable
put
Upsert user approval record
get
List deployments
post
Create deployment
get
Get deployment
put
Upsert deployment
delete
Delete deployment
get
List deployment variables by deployment
get
List deployment versions
post
Create a deployment version
patch
Update deployment version
get
List environments
post
Create environment
get
Get environment
put
Upsert environment
delete
Delete environment
get
List job agents
get
Get a job agent
put
Upsert a job agent
delete
Delete a job agent
get
List jobs
get
Get job
put
Update job status
get
Get job with release
get
List policies
post
Create a policy
get
Get a policy by ID
put
Upsert a policy by ID
delete
Delete a policy by ID
get
Get relationship rules for a given workspace
post
Create relationship rule
get
Get relationship
put
Upsert relationship
delete
Delete relationship
post
Preview release targets for a resource
post
Get release target states by deployment and environment
get
Get the desired release for a release target
get
Get jobs for a release target
get
Get the state for a release target
get
Get release
put
Upsert resource provider
get
Get a resource provider by name
put
Set the resources for a provider
get
List systems
post
Create system
get
Get system
put
Upsert system
delete
Delete system
get
Get deployment system link
put
Link deployment to system
delete
Unlink deployment from system
get
Get environment system link
put
Link environment to system
delete
Unlink environment from system
Create deployment
post
/v1/workspaces/{workspaceId}/deployments
Path parameters
workspaceId
string
required
ID of the workspace
Request body
CreateDeploymentRequest
required
description
string
jobAgentConfig
object
jobAgentId
string
jobAgents
DeploymentJobAgent[]
metadata
object
name
string
required
resourceSelector
union
slug
string
required
Response
Accepted response
DeploymentRequestAccepted
required
id
string
required
message
string
required
Changes