Environments

UpdateEnvironmentSchedule

Updates the configuration of a scheduled action for a Pulumi ESC environment. The schedule is identified by the scheduleID path parameter. The request body specifies the updated timing and action configuration. Changes take effect for future executions only; any currently running execution is not affected. Returns the updated ScheduledAction on success.

patch/api/esc/environments/{orgName}/{projectName}/{envName}/schedules/{scheduleID}

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/esc/environments/{orgName}/{projectName}/{envName}/schedules/{scheduleID}
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

projectNamestring required

The project name

envNamestring required

The environment name

scheduleIDstring required

The schedule ID

Request body

scheduleCronstring

The schedule cron

scheduleOncestring date-time

The schedule once

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.