Deployments
Schedules

CreateScheduledDeployment

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.

post/api/stacks/{orgName}/{projectName}/{stackName}/deployments/schedules

Request

  • Base URL: https://api.pulumi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pulumi.com/api/stacks/{orgName}/{projectName}/{stackName}/deployments/schedules
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

projectNamestring required

The project name

stackNamestring required

The stack name

Request body

scheduleCronstring

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.

scheduleOncestring date-time

Single point-in-time schedule for this deployment. When set, scheduleCron must be null. The value must be an ISO 8601 timestamp with timezone.

Response

OK

createdstring required

The timestamp when this scheduled action was created.

definitionobject required

The action definition, which varies based on the action kind.

idstring required

The unique identifier for this scheduled action.

kind'deployment' | 'environment_rotation' | 'scan' | 'agent_automation' required

The kind of action to be executed.

lastExecutedstring required

The timestamp of the last execution, if any.

modifiedstring required

The timestamp when this scheduled action was last modified.

nextExecutionstring required

The timestamp of the next scheduled execution.

orgIDstring required

The organization ID that owns this scheduled action.

pausedboolean required

Whether the scheduled action is currently paused.

scheduleCronstring

A cron expression defining the recurring schedule.

scheduleOncestring

A timestamp for a one-time scheduled execution.

Changes

No recorded changes to this operation across all 1 revision of this API.