Schedules

Creates a drift detection schedule for a stack using Pulumi Deployments. Drift detection identifies divergence between the declared infrastructure state in your Pulumi program and the actual state of resources in the cloud provider. The ‘scheduleCron’ field accepts a cron expression defining when drift detection should run (e.g. ‘0 */4 * * *’ for every 4 hours). When ‘autoRemediate’ is set to true, a remediation update is automatically triggered to bring resources back into alignment with the declared state whenever drift is detected. Auto-remediation requires a Business Critical subscription. The stack must have deployment settings configured before a drift schedule can be created.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name

Request Body

• scheduleCron string optional
  Cron expression defining when drift detection should run (e.g. ‘0 */4 * * *’ for every 4 hours).
• autoRemediate boolean optional
  If true, automatically run a remediation update when drift is detected.

Responses

Updates the configuration of an existing drift detection schedule. The request body can modify the cron expression controlling when drift detection runs and the autoRemediate flag that determines whether detected drift is automatically corrected by running an update operation. Auto-remediation requires a Business Critical subscription. Only future executions are affected; past drift detection runs are not modified.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• scheduleID string path required
  The schedule identifier

Request Body

• scheduleCron string optional
  Cron expression defining when drift detection should run (e.g. ‘0 */4 * * *’ for every 4 hours).
• autoRemediate boolean optional
  If true, automatically run a remediation update when drift is detected.

Responses

Returns all scheduled deployment actions configured for a stack. The response includes all schedule types: custom deployment schedules (cron-based recurring or one-time), drift detection schedules, and TTL (time-to-live) schedules. Each schedule in the response contains its ID, type, configuration (cron expression or timestamp), current status (active or paused), and the deployment request that will be executed on each run.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name

Responses

Creates a custom deployment schedule for a stack using Pulumi Deployments. Custom schedules allow you to automate recurring or one-time Pulumi operations on a stack. The request must include exactly one of ‘scheduleCron’ (a cron expression for recurring executions, e.g. ‘0 */4 * * *’ for every 4 hours) or ‘scheduleOnce’ (an ISO 8601 timestamp for a one-time execution). The ‘request’ field contains the deployment configuration that will be executed on each scheduled run, including the Pulumi operation type and any settings overrides. The stack must have deployment settings configured before a schedule can be created.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name

Request Body

• scheduleCron string optional
  Cron expression defining a recurring schedule for this deployment. When set, scheduleOnce must be null. Uses standard 5-field cron syntax (MIN HOUR DOM MON DOW) and is evaluated in UTC.
• scheduleOnce string optional
  Single point-in-time schedule for this deployment. When set, scheduleCron must be null. The value must be an ISO 8601 timestamp with timezone.
• request CreateDeploymentRequest optional
  Deployment request payload to execute when the schedule fires. This has the same shape and semantics as CreateDeploymentRequest used for immediate deployments.
• ↳ operation enum optional
  The Pulumi operation to perform.
  Values: update, preview, destroy, refresh, detect-drift, remediate-drift
• ↳ tag string optional
  A tag to identify the deployment settings configuration.
• ↳ executorContext ExecutorSettingsRequest optional
  The executor context defining the execution environment.
• ↳ inheritSettings boolean optional
  Whether this deployment should inherit the stack’s deployment settings. Defaults to true.
• ↳ sourceContext SourceContextRequest optional
  The source context defining where the source code is located.
• ↳ gitHub DeploymentSettingsGitHubRequest optional
  GitHub-specific deployment settings
• ↳ vcs DeploymentSettingsVCS optional
  VCS provider settings
• ↳ operationContext OperationContextRequest optional
  The operation context defining pre-run and post-run commands and environment variables.
• ↳ agentPoolID string optional
  The identifier of the agent pool to use for deployments.
• ↳ cacheOptions CacheOptionsRequest optional
  Cache options for the deployment.

Responses

Retrieves the full configuration and metadata for a specific scheduled deployment action. The response includes the schedule’s ID, type (custom, drift, or TTL), timing configuration (cron expression or one-time timestamp), current status (active or paused), the deployment request that will be executed, and any type-specific fields such as autoRemediate for drift schedules or deleteAfterDestroy for TTL schedules.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• scheduleID string path required
  The schedule identifier

Responses

Updates the configuration of an existing custom deployment schedule. The request body can modify the timing (cron expression for recurring schedules or ISO 8601 timestamp for one-time schedules) and the deployment request that will be executed on each future run, including the Pulumi operation type and settings overrides. Only future executions are affected; past executions are not modified. The stack must have deployment settings configured.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• scheduleID string path required
  The schedule identifier

Request Body

• scheduleCron string optional
  Cron expression defining a recurring schedule for this deployment. When set, scheduleOnce must be null. Uses standard 5-field cron syntax (MIN HOUR DOM MON DOW) and is evaluated in UTC.
• scheduleOnce string optional
  Single point-in-time schedule for this deployment. When set, scheduleCron must be null. The value must be an ISO 8601 timestamp with timezone.
• request CreateDeploymentRequest optional
  Deployment request payload to execute when the schedule fires. This has the same shape and semantics as CreateDeploymentRequest used for immediate deployments.
• ↳ operation enum optional
  The Pulumi operation to perform.
  Values: update, preview, destroy, refresh, detect-drift, remediate-drift
• ↳ tag string optional
  A tag to identify the deployment settings configuration.
• ↳ executorContext ExecutorSettingsRequest optional
  The executor context defining the execution environment.
• ↳ inheritSettings boolean optional
  Whether this deployment should inherit the stack’s deployment settings. Defaults to true.
• ↳ sourceContext SourceContextRequest optional
  The source context defining where the source code is located.
• ↳ gitHub DeploymentSettingsGitHubRequest optional
  GitHub-specific deployment settings
• ↳ vcs DeploymentSettingsVCS optional
  VCS provider settings
• ↳ operationContext OperationContextRequest optional
  The operation context defining pre-run and post-run commands and environment variables.
• ↳ agentPoolID string optional
  The identifier of the agent pool to use for deployments.
• ↳ cacheOptions CacheOptionsRequest optional
  Cache options for the deployment.

Responses

Permanently deletes a scheduled deployment action from a stack. This removes the schedule configuration entirely and cannot be undone. The schedule will no longer execute any future runs. This endpoint is used for all schedule types (custom, drift detection, and TTL). To temporarily stop a schedule without deleting it, use the pause endpoint instead.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• scheduleID string path required
  The schedule identifier

Responses

Returns the execution history for a specific scheduled deployment action. The response includes a chronological list of past schedule invocations and their outcomes, such as whether the triggered deployment succeeded, failed, or was skipped. This is useful for monitoring the reliability and results of recurring deployments, drift detection runs, or TTL schedule executions.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• scheduleID string path required
  The schedule identifier

Responses

Temporarily suspends future executions of a scheduled deployment action without deleting the schedule configuration. The schedule remains configured and can be reactivated at any time using the ResumeScheduledDeployment endpoint. This is useful for temporarily halting recurring schedules (drift detection, TTL, or custom) during maintenance periods or when troubleshooting issues.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• scheduleID string path required
  The schedule identifier

Responses

Reactivates a previously paused scheduled deployment action. After resuming, the schedule will continue executing according to its configured timing (cron expression for recurring schedules, or at the scheduled timestamp for one-time schedules). This works for all schedule types: custom deployment schedules, drift detection schedules, and TTL schedules.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• scheduleID string path required
  The schedule identifier

Responses

Creates a TTL (time-to-live) schedule for a stack using Pulumi Deployments. TTL schedules automatically destroy a stack’s cloud resources at a specified expiration time, which is useful for temporary or ephemeral infrastructure that should be cleaned up after a defined period. The ’timestamp’ field must be an ISO 8601 formatted date-time (e.g. ‘2024-12-31T00:00:00.000Z’) specifying when the destroy operation should execute. When ‘deleteAfterDestroy’ is set to true, the stack itself is also removed from Pulumi Cloud after its resources have been successfully destroyed. The stack must have deployment settings configured before a TTL schedule can be created.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name

Request Body

• timestamp string optional
  When the TTL expires and the stack should be destroyed, in ISO 8601 format.
• deleteAfterDestroy boolean optional
  If true, delete the stack from Pulumi Cloud after successfully destroying its resources.

Responses

Updates the configuration of an existing TTL (time-to-live) schedule. The request body can modify the destruction timestamp (ISO 8601 format) and the deleteAfterDestroy flag that controls whether the stack is also removed from Pulumi Cloud after its resources are successfully destroyed. The timestamp field is required and must be set to a valid future date-time.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• scheduleID string path required
  The schedule identifier

Request Body

• timestamp string optional
  When the TTL expires and the stack should be destroyed, in ISO 8601 format.
• deleteAfterDestroy boolean optional
  If true, delete the stack from Pulumi Cloud after successfully destroying its resources.

Responses