{ "opencollection": "1.0.0", "info": { "name": "Pulumi APIs AccessTokens Deployments API", "version": "1.0.0" }, "items": [ { "info": { "name": "Deployments", "type": "folder" }, "items": [ { "info": { "name": "GetPulumiDeployExecutor", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/deployments/executor" }, "docs": "Streams the Linux/AMD64 Pulumi Deployments executor binary to the requester. The executor is the component that runs inside a deployment container and executes the actual Pulumi operations. The binary is retrieved from the Docker image/filesystem and proxied through the service to control access. This API is for internal use by workflow runners and requires valid credentials." }, { "info": { "name": "PollDeploymentsQueue", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/deployments/poll" }, "docs": "Polls the Pulumi Deployments queue for available work to execute. This endpoint is used by self-hosted deployment agents running in agent pools to pick up queued deployment jobs. Returns 200 with the next available deployment's workflow definition if work is available, or 204 No Content if the queue is empty. Agents should poll this endpoint repeatedly. Authenticated using an agent pool secret rather than a user access token." }, { "info": { "name": "GetDeploymentsStatus", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/deployments/:deploymentId/status", "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment identifier" } ] }, "docs": "Returns the current execution status of a Pulumi Deployments run. This endpoint is used by self-hosted deployment agents running in agent pools to check whether a deployment is still active. Authenticated using an agent pool secret rather than a user access token." }, { "info": { "name": "ListOrgDeployments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/deployments", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "asc", "value": "", "type": "query", "description": "Sort in ascending order when true (default false)" }, { "name": "page", "value": "", "type": "query", "description": "Page number (min 1, default 1)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Results per page (1-100, default 10)" }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort results by" } ] }, "docs": "Returns a paginated list of all Pulumi Deployments executions across an organization, filtered to only include deployments for stacks the requesting user has access to. The response includes each deployment's ID, status, version, creation time, the requesting user, project and stack names, Pulumi operation type, job details, and associated update results. Use 'page' (minimum 1, default 1) and 'pageSize' (1-100, default 10) for pagination, 'sort' to specify the sort field, and 'asc' to control so" }, { "info": { "name": "OrgDeploymentsMetadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/deployments/metadata", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns metadata about the organization's Pulumi Deployments state. The response includes the overall pause status, a list of individually paused stacks (as stack references like `project/stack`), the configured concurrency limit (maximum number of concurrent deployments), and deployment counts broken down by status (`notStarted`, `accepted`, `running`, `failed`, `succeeded`, `skipped`, and `total`). This endpoint is useful for monitoring deployment health and capacity across an organization." }, { "info": { "name": "PauseOrgDeployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/deployments/pause", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Pauses all future Pulumi Deployments executions across an entire organization. While paused, new deployments can still be queued and currently executing deployments will continue to run to completion. However, queued deployments will not be picked up for execution until deployments are resumed. This provides a safety mechanism to temporarily halt all deployment activity across the organization, for example during maintenance windows or incident response. Requires organization administrator permi" }, { "info": { "name": "ResumeOrgDeployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/deployments/resume", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Resumes Pulumi Deployments executions for an organization that was previously paused via PauseOrgDeployments. Any queued deployments that accumulated while the organization was paused will begin processing according to the organization's concurrency limits. Requires organization administrator permissions." }, { "info": { "name": "GetUsageSummaryDeployCompute", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/deployments/summary", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "granularity", "value": "", "type": "query", "description": "Time granularity for the summary (e.g. 'daily', 'hourly')" }, { "name": "lookbackDays", "value": "", "type": "query", "description": "Number of days to look back from the current date" }, { "name": "lookbackStart", "value": "", "type": "query", "description": "Start of the lookback period (Unix timestamp)" } ] }, "docs": "Retrieves a summary of Pulumi Deployments compute usage (deployment minutes) for an organization. The response provides aggregated deployment minute consumption over the specified time period. Use the 'granularity' parameter to control time bucketing (e.g. 'daily' or 'hourly'), and either 'lookbackDays' (number of days from the current date) or 'lookbackStart' (a Unix timestamp) to define the reporting window. Returns 204 No Content if no usage data is available for the specified period." }, { "info": { "name": "GetDeployUsageReport", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/deployments/usagereport", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "lookbackDays", "value": "", "type": "query", "description": "Number of days to look back" } ] }, "docs": "Retrieves raw deployment usage records for self-hosted Pulumi Cloud customers to self-report deployment consumption. Returns aggregated deployment usage records for the specified organization. The 'lookbackDays' query parameter controls how far back in time to retrieve records. This endpoint is primarily used by self-hosted customers for usage reporting and billing reconciliation purposes." }, { "info": { "name": "ListStackDeploymentsHandlerV2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "asc", "value": "", "type": "query", "description": "Sort in ascending order when true (default false)" }, { "name": "page", "value": "", "type": "query", "description": "Page number (min 1, default 1)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Results per page (1-100, default 10)" }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort results by" } ] }, "docs": "Returns a paginated list of Pulumi Deployments executions for a specific stack. The response includes each deployment's ID, status, version, creation and modification timestamps, the requesting user, Pulumi operation type, job details with step-level progress, and associated stack update results. Use 'page' (minimum 1, default 1) and 'pageSize' (1-100, default 10) for pagination, 'sort' to specify the sort field, and 'asc' to control sort direction (default descending). The response also include" }, { "info": { "name": "CreateAPIDeploymentHandlerV2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates a new Pulumi Deployments execution for a stack. Pulumi Deployments is a managed service that executes Pulumi operations (update, preview, refresh, or destroy) in a secure, hosted environment.\n\n**Important:** The stack must already exist before a deployment can be created for it.\n\nThe `operation` field is required and accepts: `update`, `preview`, `refresh`, or `destroy`. Three usage modes are supported:\n1. **Stack settings only:** Send `{\"operation\": \"update\"}` to use the stack's saved" }, { "info": { "name": "ClearProjectCache", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/cache", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Clears all cached dependency and build artifacts associated with the project for Pulumi Deployments. The deployment cache stores dependencies and other artifacts between deployment runs to speed up execution. Use this endpoint to force a clean build on the next deployment, for example when cached dependencies become stale or corrupted." }, { "info": { "name": "GetPresignedCacheURL", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/cache/url", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a presigned URL for saving or restoring the Pulumi Deployments dependency cache. The cache stores build artifacts and dependencies between deployment runs to speed up execution. The request body must specify a method (PUT to upload a cache archive, or GET to download one) and a non-empty cache key identifying the cached content. The returned presigned URL can be used directly for the corresponding HTTP operation against the object store without additional authentication." }, { "info": { "name": "CreateScheduledDriftDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/drift/schedules", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 de" }, { "info": { "name": "UpdateScheduledDriftDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/drift/schedules/:scheduleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "StackDeploymentsMetadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/metadata", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Returns metadata about the Pulumi Deployments state for a specific stack. The response distinguishes the source of any pause:\n\n- `paused`: overall pause status (true if either stack or org is paused)\n- `stackPaused`: whether the stack itself is paused\n- `organizationPaused`: whether the containing organization is paused\n\nThis is useful for determining whether new deployments will be processed or held in the queue." }, { "info": { "name": "PauseStackDeployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/pause", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Pauses all future Pulumi Deployments executions for a specific stack. While paused, new deployments can still be queued and currently executing deployments will continue to run to completion. However, queued deployments will not be picked up for execution until deployments are resumed. The stack must have deployment settings configured before it can be paused. Requires stack deployment create permissions. Use the ResumeStackDeployments endpoint to resume processing." }, { "info": { "name": "ResumeStackDeployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/resume", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Resumes Pulumi Deployments executions for a stack that was previously paused via PauseStackDeployments. Any queued deployments that accumulated while the stack was paused will begin processing. The stack must have deployment settings configured. Requires stack deployment create permissions." }, { "info": { "name": "ListScheduledDeployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "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." }, { "info": { "name": "CreateScheduledDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 oper" }, { "info": { "name": "ReadScheduledDeployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules/:scheduleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ] }, "docs": "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." }, { "info": { "name": "UpdateScheduledDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules/:scheduleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "DeleteScheduledDeployment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules/:scheduleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ] }, "docs": "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." }, { "info": { "name": "ListScheduledDeploymentHistory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules/:scheduleID/history", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ] }, "docs": "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." }, { "info": { "name": "PauseScheduledDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules/:scheduleID/pause", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ] }, "docs": "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." }, { "info": { "name": "ResumeScheduledDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules/:scheduleID/resume", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ] }, "docs": "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." }, { "info": { "name": "GetDeploymentSettings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/settings", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Retrieves the Pulumi Deployments configuration for a specified stack. The response includes all saved deployment settings: source context (git repository URL, branch, and directory), operation context (environment variables, pre-run commands, OIDC provider configuration), executor context (deployment executor configuration), GitHub integration settings (repository, paths, deployment triggers), and cache options for dependency caching between runs. These settings serve as the baseline configurati" }, { "info": { "name": "PatchDeploymentSettings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/settings", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates Pulumi Deployments settings for a stack using a merge operation. If no settings exist, they are created. If settings already exist, the request body is merged with the current settings using the following logic: for each property, start with the current value, remove it if the patch specifies null, or merge the new non-null value with the existing one. Non-object properties (strings, numbers, booleans) are replaced entirely. Settings include source context (git repository URL," }, { "info": { "name": "ReplaceDeploymentSettings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/settings", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Fully replaces the Pulumi Deployments settings for a stack. Unlike the PATCH endpoint (PatchDeploymentSettings) which merges changes, this endpoint replaces all settings with the provided values. Any previously configured settings not included in the request body will be removed. Settings include source context (git repository URL, branch, directory), operation context (environment variables, pre-run commands, OIDC configuration), executor context, GitHub integration settings, and cache options." }, { "info": { "name": "DeleteDeploymentSettings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/settings", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Removes all Pulumi Deployments settings for a stack, including source context, operation context, executor context, GitHub integration settings, and cache options. After deletion, the stack can no longer run deployments until new settings are configured. Any active schedules (drift detection, TTL, or custom) associated with the stack may also be affected." }, { "info": { "name": "EncryptDeploymentSettingsSecret", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/settings/encrypt", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Encrypts a plaintext secret value for secure storage in Pulumi Deployments settings. Use this endpoint to encrypt sensitive values such as cloud provider credentials, API keys, or other secrets before including them in deployment settings (e.g. as environment variables in operationContext). The encrypted value can then be safely stored in the deployment settings and will be decrypted at deployment execution time. The request body must contain a non-empty plaintext value to encrypt." }, { "info": { "name": "CreateScheduledTTLDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/ttl/schedules", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 remov" }, { "info": { "name": "UpdateScheduledTTLDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/ttl/schedules/:scheduleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetDeployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/version/:version", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "version", "value": "", "type": "path", "description": "The deployment version number" } ] }, "docs": "Retrieves detailed information about a specific Pulumi Deployments execution by its version number within the stack. This is an alternative to fetching by deployment ID and returns the same response structure: deployment status, creation and modification timestamps, the user who requested the deployment, the Pulumi operation type, job details with step-level progress, and any associated stack update results." }, { "info": { "name": "GetDeployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/:deploymentId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment identifier" } ] }, "docs": "Retrieves detailed information about a specific Pulumi Deployments execution by its deployment ID. The response includes the deployment's current status, creation and modification timestamps, version number, the user who requested the deployment, the Pulumi operation type (update, preview, refresh, or destroy), and detailed job information. Each job contains an array of steps with their individual statuses (not-started, running, succeeded, or failed), start times, and last update timestamps. The" }, { "info": { "name": "CancelDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/:deploymentId/cancel", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment identifier" } ] }, "docs": "Terminates an in-progress Pulumi Deployments execution for a specific stack. If the deployment is currently running, it is stopped immediately. If the deployment is queued but has not yet started, it is removed from the queue.\n\n**Warning:** Canceling a deployment is a dangerous action and may leave the stack in an inconsistent state if the deployment is canceled during the execution of a Pulumi operation.\n\nNote that this serves two endpoints:\n- /{orgName}/{projectName}/{stackName}/deployments/{d" }, { "info": { "name": "GetDeploymentLogs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/:deploymentId/logs", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment identifier" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for streaming logs; use nextToken from the previous response to fetch subsequent log entries" }, { "name": "count", "value": "", "type": "query", "description": "Number of log lines to return (1-499, default 100)" }, { "name": "job", "value": "", "type": "query", "description": "Zero-based job index to retrieve logs for" }, { "name": "offset", "value": "", "type": "query", "description": "Zero-based line offset within the step logs" }, { "name": "step", "value": "", "type": "query", "description": "Zero-based step index within the specified job" } ] }, "docs": "Retrieves execution logs for a Pulumi Deployments run. Supports two retrieval modes: streaming mode and step mode. In streaming mode, omit job/step parameters and use the continuationToken to incrementally fetch logs from the beginning through completion. Each response includes a nextToken field; continue requesting with this token until nextToken is absent, indicating all logs have been retrieved. In step mode, specify job and step indices to retrieve logs for a specific step within a specific " }, { "info": { "name": "GetDeploymentUpdates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/:deploymentId/updates", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment identifier" } ] }, "docs": "Retrieves all stack updates (program updates) associated with a specific Pulumi Deployments execution. A single deployment may produce one or more stack updates depending on the operation performed. Each update in the response includes details such as the update ID, version, start and end times, result status, and resource changes. This is useful for correlating deployment executions with their resulting infrastructure changes." }, { "info": { "name": "ListDriftRuns", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/drift/runs", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "page", "value": "", "type": "query", "description": "Page number (min 1, default 1)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Results per page (1-100, default 10)" } ] }, "docs": "Returns a paginated list of all drift detection runs for a stack. Each drift run represents a scheduled or manually triggered drift detection execution and includes details about whether drift was detected and any remediation actions taken. Use the 'page' (minimum 1, default 1) and 'pageSize' (1-100, default 10) query parameters for pagination." }, { "info": { "name": "GetStackDriftStatus", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/drift/status", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Retrieves the current drift detection status and associated metadata for a stack. Drift occurs when the actual state of cloud resources diverges from the state declared in the Pulumi program. The response indicates whether drift has been detected, when the last drift check was performed, and details about any detected differences. This is used in conjunction with drift detection schedules to monitor infrastructure compliance." } ] } ], "bundled": true }