CreateScheduledTTLDeployment

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.

post/api/stacks/{orgName}/{projectName}/{stackName}/deployments/ttl/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/ttl/schedules
Auth: none declared

Path parameters

orgNamestring required

The organization name

projectNamestring required

The project name

stackNamestring required

The stack name

Request body

deleteAfterDestroyboolean

If true, delete the stack from Pulumi Cloud after successfully destroying its resources.

timestampstring date-time

When the TTL expires and the stack should be destroyed, in ISO 8601 format.

Response

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.