Pulumi Deployments API
The Deployments API from Pulumi — 33 operation(s) for deployments.
Pulumi Deployments API is one of 35 APIs that Pulumi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 40 operations across 33 paths, and defines 85 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://api.pulumi.com.
40 operations
33 paths
85 schemas
3 DELETE19 GET17 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 40
Across 33 paths, the API surfaces 40 operations — 3 DELETE, 19 GET, 17 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Deployments 40
GET
/api/deployments/executor
GetPulumiDeployExecutor
GET
/api/deployments/poll
PollDeploymentsQueue
GET
/api/deployments/{deploymentId}/status
GetDeploymentsStatus
GET
/api/orgs/{orgName}/deployments
ListOrgDeployments
GET
/api/orgs/{orgName}/deployments/metadata
OrgDeploymentsMetadata
POST
/api/orgs/{orgName}/deployments/pause
PauseOrgDeployments
POST
/api/orgs/{orgName}/deployments/resume
ResumeOrgDeployments
GET
/api/orgs/{orgName}/deployments/summary
GetUsageSummaryDeployCompute
GET
/api/orgs/{orgName}/deployments/usagereport
GetDeployUsageReport
GET
/api/stacks/{orgName}/{projectName}/{stackName}/deployments
ListStackDeploymentsHandlerV2
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments
CreateAPIDeploymentHandlerV2
DELETE
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/cache
ClearProjectCache
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/cache/url
GetPresignedCacheURL
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/drift/schedules
CreateScheduledDriftDeployment
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/drift/schedules/{scheduleID}
UpdateScheduledDriftDeployment
GET
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/metadata
StackDeploymentsMetadata
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/pause
PauseStackDeployments
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/resume
ResumeStackDeployments
GET
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/schedules
ListScheduledDeployment
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/schedules
CreateScheduledDeployment
DELETE
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/schedules/{scheduleID}
DeleteScheduledDeployment
GET
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/schedules/{scheduleID}
ReadScheduledDeployment
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/schedules/{scheduleID}
UpdateScheduledDeployment
GET
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/schedules/{scheduleID}/history
ListScheduledDeploymentHistory
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/schedules/{scheduleID}/pause
PauseScheduledDeployment
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/schedules/{scheduleID}/resume
ResumeScheduledDeployment
DELETE
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/settings
DeleteDeploymentSettings
GET
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/settings
GetDeploymentSettings
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/settings
PatchDeploymentSettings
PUT
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/settings
ReplaceDeploymentSettings
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/settings/encrypt
EncryptDeploymentSettingsSecret
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/ttl/schedules
CreateScheduledTTLDeployment
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/ttl/schedules/{scheduleID}
UpdateScheduledTTLDeployment
GET
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/version/{version}
GetDeployment
GET
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/{deploymentId}
GetDeployment
POST
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/{deploymentId}/cancel
CancelDeployment
GET
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/{deploymentId}/logs
GetDeploymentLogs
GET
/api/stacks/{orgName}/{projectName}/{stackName}/deployments/{deploymentId}/updates
GetDeploymentUpdates
GET
/api/stacks/{orgName}/{projectName}/{stackName}/drift/runs
ListDriftRuns
GET
/api/stacks/{orgName}/{projectName}/{stackName}/drift/status
GetStackDriftStatus
Schemas 85
The contract defines 85 schemas that model the data the API accepts and returns. The most detailed are GetDeploymentResponse (11 properties), AppUpdateInfo (11 properties), ScheduledAction (11 properties), DeploymentSettings (10 properties). Each schema is shown below with its type and property counts.
DeploymentSettingsRequest
object
DeploymentSettingsRequest is the request body for creating or updating deployment settings.
8 properties
OperationContextGCPOIDCConfigurationRequest
object
Request body for updating the GCP OIDC configuration of an operation context.
6 properties
StackDeploymentsMetadataResponse
object
Metadata related to all of a stack's deployments. This is different from settings in that it applies to all deployments with the same ProgramID; it's not confi…
5 properties
4 required
GitAuthConfigRequest
object
Request body for configuring git authentication options.
3 properties
SourceContextRequest
object
Request to configure a source context: git-based, Mercurial-based, or template-based. Only one may be specified.
3 properties
ScheduledActionHistoryEvent
object
ScheduledActionHistoryEvent describes the state of a scheduled deployment history event.
5 properties
5 required
CreateDeploymentResponse
object
CreateDeploymentResponse defines the response given when a new Deployment is created.
3 properties
3 required
ResourceCountSummary
object
ResourceCountSummary represents a single point of summary for resources under management for an organization.
7 properties
3 required
ListScheduledActionHistoryResponse
object
ListScheduledActionHistoryResponse is the API response when a scheduled action history is listed.
1 property
1 required
DeploymentSourceGit
object
DeploymentSourceGit is like SourceContextGit but does not include the Auth data as we don't want to include that in our deployment response.
4 properties
1 required
CacheOptions
object
Configuration options for deployment build caching.
1 property
1 required
SSHAuthRequest
object
Request to configure SSH-based authentication for git operations.
2 properties
DeploymentSettingsGitHub
object
DeploymentSettingsGitHub contains GitHub-specific configuration for Pulumi Deployments.
8 properties
ListDeploymentSnapshotAgentPool
object
Agent pool information associated with a deployment snapshot.
2 properties
2 required
ExecutorSettingsRequest
object
ExecutorSettingsRequest is the request body for configuring the execution environment settings.
2 properties
DeploymentSettingsGitHubRequest
object
DeploymentSettingsGitHubRequest is the request body for updating GitHub-specific deployment settings.
8 properties
1 required
ExecutorContext
object
ExecutorContext defines the execution environment for a deployment, including the Docker image to use.
2 properties
UpdateInfo
object
UpdateInfo is an extension to the simpler pulumi CLI's UpdateInfo object.
8 properties
5 required
ScheduledAction
object
ScheduledAction describes the state of a scheduled action.
11 properties
9 required
DeploymentNestedUpdate
object
DeploymentNestedUpdate represents an update that is nested within a deployment, including its status and metadata.
9 properties
9 required
SecretValue
object
A SecretValue describes a secret value on the wire. The JSON representation is an object with a required 'secret' field containing the plaintext and an optiona…
2 properties
1 required
DeploymentSourceTemplate
object
DeploymentSourceTemplate is like SourceContextTemplate but does not include the Auth data as we don't want to include that in the deployment response.
1 property
1 required
ListScheduledActionsResponse
object
ListScheduledActionsResponse is the API response when scheduled deployments are listed.
1 property
1 required
DeploymentSettingsVCS
object
DeploymentSettingsVCS contains VCS provider deployment settings.
8 properties
1 required
DockerImage
object
A DockerImage describes a Docker image reference + optional credentials for use with aa job definition.
3 properties
1 required
DockerImageCredentialsRequest
object
DockerImageCredentialsRequest is the request body for specifying Docker registry credentials.
2 properties
AgentWorkflowDefinition
object
Defines an agent workflow.
6 properties
5 required
OperationContextOIDCConfigurationRequest
object
Request body for updating the OIDC configuration of an operation context.
3 properties
AppConfigValue
object
ConfigValue describes a single (possibly secret) configuration value.
3 properties
3 required
SSHAuth
object
SSHAuth configures ssh-based auth for git authentication. SSHPrivateKey is required but password is optional.
2 properties
1 required
OperationContextRequest
object
Request body for updating an operation context.
6 properties
GitAuthConfig
object
GitAuthConfig specifies git authentication configuration options. There are 3 different authentication options: - Personal access token - SSH private key (and…
3 properties
AppPolicyPackMetadata
object
PolicyPackMetadata is the metadata of a Policy Pack.
6 properties
4 required
SourceContextGit
object
Git-based source context for obtaining source code from a repository.
5 properties
DeploymentLogsBase
object
DeploymentLogsBase is the base type for deployment log responses, discriminated by type.
1 property
1 required
BaseUsageRecord
object
Only deploy usage records populate the count field. This struct makes it easier to scan non-deploy usage records (with no counts) from the database.
5 properties
5 required
SourceContextHg
object
Mercurial-based source context for obtaining source code from a repository.
5 properties
CreateDeploymentRequest
BasicAuth
object
BasicAuth configures git authentication through basic auth — i.e. username and password. Both UserName and Password are required.
2 properties
2 required
EnvironmentVariable
object
EnvironmentVariable is a key-value pair; if the variable is secret, value will be empty/omitted.
3 properties
2 required
UserInfo
object
UserInfo contains just the display information for a user. This information may be returned from public APIs, and as such this structure must not contain sensi…
4 properties
3 required
GetResourceCountSummaryResponse
object
Response body for retrieving a summary of resource counts.
1 property
1 required
CreateScheduledDeploymentRequest
object
CreateScheduledDeploymentRequest is the API request for a scheduled deployment.
3 properties
DockerImageRequest
object
DockerImageRequest is the request body for specifying a Docker image and its credentials.
2 properties
OperationContextGCPOIDCConfiguration
object
OperationContextGCPOIDCConfiguration contains information about how to exchange an OIDC token for temporary GCP credentials in the form of a service account co…
6 properties
4 required
DeploymentSource
object
DeploymentSource describes the source of a deployment, which may be a Git repository or a template.
2 properties
CreateScheduledDriftDeploymentRequest
object
CreateScheduledDriftDeploymentRequest is the API request for a scheduled drift deployment.
2 properties
SourceContextTemplate
object
Template-based source context for obtaining source code from a template URL.
2 properties
OperationContext
object
OperationContext describes what to do.
6 properties
SourceContextTemplateRequest
object
Request to configure a template-based source context.
2 properties
SourceContext
object
SourceContext describes some source code, and how to obtain it.
3 properties
StackDriftStatus
object
The drift detection status for a stack.
3 properties
3 required
SourceContextHgRequest
object
Request to configure a Mercurial-based source context.
5 properties
DriftRun
object
DriftRun represents a drift detection run, including whether drift was detected and any associated updates.
8 properties
4 required
BasicAuthRequest
object
Request body for basic auth.
2 properties
OperationContextAzureOIDCConfiguration
object
OperationContextAzureOIDCConfiguration contains information about how to exchange an OIDC token for temporary Azure credentials in the form of a federated work…
3 properties
SourceContextGitRequest
object
Request to configure a git-based source context.
5 properties
CacheOptionsRequest
object
Request body for updating deployment build cache options.
1 property
StepRun
object
StepRun contains information about a step run.
4 properties
2 required
ListDeploymentResponse
object
ListDeploymentResponse is the response from the API when listing Deployments.
6 properties
6 required
DeploymentSettings
object
DeploymentSettings contains the configuration settings for Pulumi Deployments on a stack.
10 properties
OperationContextAWSOIDCConfiguration
object
OperationContextAWSOIDCConfiguration contains information about how to exchange an OIDC token for temporary AWS credentials in the form of an assume-role sessi…
4 properties
2 required
DeploymentConfiguration
object
DeploymentConfiguration contains the configuration for a deployment, including environment variables and source settings.
2 properties
1 required
AppUpdateInfo
object
UpdateInfo describes a previous update. Should generally mirror backend.UpdateInfo, but we clone it in this package to add flexibility in case there is a break…
11 properties
8 required
CacheURLRequest
object
Request body for cache url.
2 properties
2 required
ListDriftRunsResponse
object
Response containing a paginated list of drift detection runs.
3 properties
3 required
CreateScheduledTTLDeploymentRequest
object
CreateScheduledTTLDeploymentRequest is the API request for a ttl scheduled deployment.
2 properties
OperationContextAWSOIDCConfigurationRequest
object
Request body for updating the AWS OIDC configuration of an operation context.
4 properties
UsageRecord
OperationContextOptions
object
OperationContextOptions is a bag of settings to specify or override default behavior in a deployment
5 properties
GetDeploymentResponse
object
GetDeploymentResponse is the response from the API when getting a single Deployment.
11 properties
7 required
DeploymentCounts
object
DeploymentCounts contains the count of deployments in each status category.
7 properties
7 required
OperationContextAzureOIDCConfigurationRequest
object
Request body for updating the Azure OIDC configuration of an operation context.
3 properties
ListDeploymentResponseV2
object
Response containing a paginated list of deployment snapshots (v2).
3 properties
3 required
CacheURLResponse
object
Response body for cache url.
1 property
1 required
DeploymentRoleRequest
object
DeploymentRoleRequest represents a request to create or update a deployment role.
3 properties
ListDeploymentSnapshot
DriftRunUpdate
object
DriftRunUpdate represents an update within a drift run, including resource changes and status.
4 properties
3 required
DockerImageCredentials
object
DockerImageCredentials describes the credentials needed to access a Docker repository.
2 properties
2 required
OperationContextOptionsRequest
object
Request body for updating operation context options.
5 properties
DeploymentJob
object
DeploymentJob represents a deployment job with its status, timing, and step information.
4 properties
2 required
GitHubCommitInfo
object
GitHubCommitInfo contains summary information about a GitHub commit. We try to provide as much information as possible, so in some situations only a subset of…
6 properties
OperationContextOIDCConfiguration
object
OperationContextOIDCConfiguration contains configuration for automatically fetching temporary credentials from cloud providers using the OIDC token issued by t…
3 properties
DeploymentRole
object
DeploymentRole represents a role used for Pulumi Deployments access control.
3 properties
1 required
OrgDeploymentsMetadataResponse
object
Response body containing deployment metadata for an organization.
3 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Pulumi 12
Other APIs Pulumi publishes across the network.
Pulumi Automation API
Pulumi AccessTokens API
Pulumi AI Agents API
Pulumi AI API
Pulumi AuditLogs API
Pulumi CloudSetup API
Pulumi DataExport API
Pulumi DeploymentRunners API
Pulumi Environments API
Pulumi Insights API
Pulumi InsightsAccounts API
Pulumi Miscellaneous API
#Deployment
Where this information came from
This is an independent, third-party profile of Pulumi Deployments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.