openapi: 3.0.3 info: description: APIs and Definitions for the Pulumi Cloud product. title: Pulumi APIs AccessTokens Stacks API version: 1.0.0 tags: - name: Stacks paths: /api/console/orgs/{orgName}/members/{userLogin}/stacks/{projectName}/{stackName}: get: description: Lists all permissions granted to a specific organization member for a given stack. The response provides a comprehensive view of the user's access, including permissions inherited from the organization's default role, permissions granted through team memberships, and permissions explicitly assigned to the user. Returns 404 if the user does not exist. operationId: ListMemberStackPermissions parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The user login in: path name: userLogin required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListMemberStackPermissionsResponse' description: OK '404': description: User summary: ListMemberStackPermissions tags: - Stacks /api/console/stacks/{orgName}/{projectName}/{stackName}/overview: get: description: Returns aggregated stack overview data optimized for display in the Pulumi Cloud web console. The response combines information from multiple sources including the stack's current state, recent activity, resource counts, and configuration into a single response to minimize round trips. operationId: GetStackOverview parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/StackOverviewResponse' description: OK summary: GetStackOverview tags: - Stacks /api/console/stacks/{orgName}/{projectName}/{stackName}/teams/{teamName}: patch: description: Modifies the permissions that a specific team has for the referenced stack. This allows setting the team's permission level (read, write, admin) for a single stack without affecting the team's permissions on other stacks. Returns 400 if the permission level is invalid or the team does not have the required base permissions. Returns 403 if the caller lacks permission to update the team. Returns 404 if the team does not exist. operationId: UpdateTeamStackPermissions parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The team name in: path name: teamName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTeamStackPermissionsRequest' x-originalParamName: body responses: '204': description: No Content '400': description: Invalid stack permission or team does not have permissions for the program '403': description: You do not have permission to update this team. '404': description: Team summary: UpdateTeamStackPermissions tags: - Stacks /api/console/stacks/{orgName}/{projectName}/{stackName}/updates/latest/summary: get: description: Returns a human-readable summary of the most recent update to the stack, without requiring a specific update ID. The summary is formatted identically to the UpdateSummary endpoint, including a tree view of resource changes. This is a convenience endpoint that automatically resolves the latest update version. Returns 404 if the stack has no updates. operationId: UpdateSummaryHandlerLatest parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsoleUpdateSummary' description: OK '404': description: Update summary: UpdateSummaryHandlerLatest tags: - Stacks /api/console/stacks/{orgName}/{projectName}/{stackName}/updates/{updateID}/summary: get: description: Returns a human-readable summary of a specific update, identified by its update ID. The summary is formatted in the same manner as generated by the CLI on 'pulumi up', including a tree view of resource changes, create/update/delete counts, and the overall result. This endpoint is optimized for display in the Pulumi Cloud web console. Returns 404 if the update does not exist. operationId: UpdateSummary parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsoleUpdateSummary' description: OK '404': description: Update summary: UpdateSummary tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}: delete: description: Removes a stack from Pulumi Cloud. By default, the stack must have no resources remaining; attempting to delete a stack that still manages resources will fail. Use the 'force' query parameter set to true to override this check and force deletion even when resources remain. The deletion is a soft-delete that hides the stack from normal queries. Returns 204 with no content on success. operationId: DeleteStack parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: When true, forces deletion even if the stack still has resources in: query name: force schema: type: boolean responses: '204': description: No Content '400': description: invalid query parameter summary: DeleteStack tags: - Stacks get: description: Retrieves detailed information about a specific stack, including its organization, project, and stack name, the current version number, all associated tags, any active update operations (with the operation kind, author, and start time), and the active update UUID. This is the primary endpoint for inspecting the current state and metadata of a stack. operationId: GetStack parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: example: activeUpdate: d333a711-4aa0-402f-be6d-72af9665fc37 currentOperation: author: jane@acme-corp.com kind: update started: 1720000000 id: acme-corp/website/production orgName: acme-corp projectName: website stackName: production version: 42 schema: $ref: '#/components/schemas/AppStack' description: OK summary: GetStack tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/activity: get: description: Returns the activity history for a stack, including updates, configuration changes, and other operations. Supports pagination via page and pageSize parameters (page 0 returns all results). Returns 400 if the page parameter is invalid. operationId: GetStackActivity parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: Page number for paginated results (0-indexed, where 0 returns all results) in: query name: page schema: format: int64 type: integer - description: Number of results per page (must be >= 1 when page > 0) in: query name: pageSize schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetStackActivityResponse' description: OK '400': description: Invalid 'page' value. summary: GetStackActivity tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/annotations/{kind}: get: description: Retrieves an annotation for a stack, identified by the annotation kind. Annotations are structured metadata that can be attached to stacks for purposes such as compliance tracking, custom metadata, or integration data. The optional 'source' and 'version' query parameters allow filtering by annotation source and specific version. Returns 404 if the annotation does not exist. operationId: GetStacksAnnotation parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The annotation kind in: path name: kind required: true schema: type: string - description: The annotation source in: query name: source schema: type: string - description: The annotation version number, used for filtering by a specific version in: query name: version schema: format: int64 type: integer responses: '200': content: application/json: schema: type: object description: OK '404': description: Annotation summary: GetStacksAnnotation tags: - Stacks patch: description: 'Creates or updates an annotation for a stack, identified by the annotation kind. Annotations are structured metadata that can be attached to stacks. The ''version'' query parameter supports optimistic concurrency control: if provided, the update only succeeds if the current annotation version matches. Returns 409 if the annotation has changed since it was read (version conflict).' operationId: UpsertStacksAnnotations parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The annotation kind in: path name: kind required: true schema: type: string - description: The annotation source in: query name: source schema: type: string - description: The expected annotation version for optimistic concurrency control in: query name: version schema: format: int64 type: integer requestBody: content: application/json: schema: type: object x-originalParamName: body responses: '204': description: No Content '409': description: the annotation has changed since it was read summary: UpsertStacksAnnotations tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/batch-decrypt: post: description: Decrypts a set of secret values in a single request using the stack's encryption key. The request body contains an array of base64-encoded ciphertexts. The response maps each ciphertext to its decrypted plaintext value. This is a more efficient alternative to calling the single-value decrypt endpoint multiple times. Returns 400 if the request body is invalid or if message authentication fails. Returns 413 if the request body exceeds the maximum allowed content size. operationId: BatchDecryptValue parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppBatchDecryptRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppBatchDecryptResponse' description: OK '400': description: body must be a JSON object or only "ciphertexts" valid within request body or ciphertexts was not an array or invalid base64 encoding or Message authentication failed '404': description: Not found '413': description: Content Too Large summary: BatchDecryptValue tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/batch-encrypt: post: description: Encrypts a set of plaintext values in a single request using the stack's encryption key. This is a more efficient alternative to calling the single-value encrypt endpoint multiple times. The response contains a map of the original plaintext values to their corresponding base64-encoded ciphertexts. Returns 413 if the request body exceeds the maximum allowed content size. operationId: BatchEncryptValue parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppBatchEncryptRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppBatchEncryptResponse' description: OK '413': description: Request Content Too Large summary: BatchEncryptValue tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/collaborators: get: deprecated: true description: Lists all collaborators for a stack, including their permission levels. This includes collaborators who have been invited but have not yet accepted their invitations. The response includes each collaborator's username and their permission level for the stack. This endpoint is deprecated. operationId: ListStackPermissions parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListStackCollaboratorsResponse' description: OK summary: ListStackPermissions tags: - Stacks x-pulumi-route-property: Deprecated: true Visibility: Public /api/stacks/{orgName}/{projectName}/{stackName}/collaborators/{userName}: delete: description: Removes a specific user's direct permission to access a stack. This only removes permissions explicitly granted to the user; permissions inherited from team membership or organization-level defaults are not affected. Returns 404 if the user does not exist. operationId: DeleteStackPermission parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The user name in: path name: userName required: true schema: type: string responses: '204': description: No Content '404': description: User summary: DeleteStackPermission tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/config: delete: description: Removes the service-managed configuration for a stack, including the secrets provider settings, encrypted key, encryption salt, and ESC environment reference. If stack configuration is returned by the API, it is used in place of the local stack config file (e.g. Pulumi.[stack].yaml). Deleting the config causes the CLI to fall back to the local config file. Returns 204 with no content on success. operationId: DeleteStackConfig parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '204': description: No Content summary: DeleteStackConfig tags: - Stacks get: description: Retrieves the service-managed configuration for a stack. The response includes the ESC environment reference, secrets provider type, encrypted key, and encryption salt. If stack configuration is returned by the API, it is used in place of the local stack config file (e.g. Pulumi.[stack].yaml). Returns 404 if no service-managed configuration exists for the stack. operationId: GetStackConfig parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppStackConfig' description: OK '404': description: Stack Config summary: GetStackConfig tags: - Stacks put: description: Updates the service-managed configuration for a stack. The request body may include the ESC environment reference, secrets provider type, encrypted key, and encryption salt. If stack configuration is returned by the API, it is used in place of the local stack config file (e.g. Pulumi.[stack].yaml). Returns the updated configuration object. Returns 400 if the environment reference is invalid or not found. operationId: UpdateStackConfig parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppStackConfig' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppStackConfig' description: OK '400': description: invalid environment or invalid environment version or environment not found summary: UpdateStackConfig tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/decrypt: post: description: Decrypts a single secret value using the stack's encryption key. The request body contains the base64-encoded ciphertext. The response contains the decrypted plaintext value. For decrypting multiple values in a single request, use the BatchDecryptValue endpoint instead. Returns 413 if the request body exceeds the maximum allowed content size. operationId: DecryptValue parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppDecryptValueRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppDecryptValueResponse' description: OK '413': description: Request Content Too Large summary: DecryptValue tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/decrypt/log-batch-decryption: post: description: Records an audit log entry for a batch decryption event performed by a third-party secrets provider. When stacks use external secrets providers (such as AWS KMS, Azure Key Vault, or HashiCorp Vault), decryption happens client-side; this endpoint allows the CLI to report that decryption occurred for audit tracking purposes. operationId: LogOnlyBatchDecryptValue parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppLog3rdPartyDecryptionEvent' x-originalParamName: body responses: '204': description: No Content summary: LogOnlyBatchDecryptValue tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/decrypt/log-decryption: post: description: Records an audit log entry for a single-value decryption event performed by a third-party secrets provider. When stacks use external secrets providers (such as AWS KMS, Azure Key Vault, or HashiCorp Vault), decryption happens client-side; this endpoint allows the CLI to report that decryption occurred for audit tracking. operationId: LogOnlyDecryptValue parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppLog3rdPartyDecryptionEvent' x-originalParamName: body responses: '204': description: No Content summary: LogOnlyDecryptValue tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/destroy: post: description: Creates a new destroy update for the given stack. A destroy update tears down all resources managed by the stack. This only creates the update record; the update must subsequently be started via the StartUpdateForDestroy endpoint. Enforces stack update concurrency checks to prevent conflicting simultaneous operations. operationId: CreateUpdateForDestroy parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUpdateProgramRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppUpdateProgramResponse' description: OK summary: CreateUpdateForDestroy tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}: get: description: Returns the current status and results of a destroy update, including whether it is still in progress, succeeded, or failed. Supports pagination of results via the continuationToken query parameter. operationId: GetUpdateStatusForDestroy parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string - description: Continuation token for paginated results in: query name: continuationToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppUpdateResults' description: OK '400': description: invalid query parameter summary: GetUpdateStatusForDestroy tags: - Stacks post: description: Starts execution of a previously created destroy update. The update must have been created via CreateUpdateForDestroy first. Returns a lease token and version number for tracking the update. Returns 404 if the update does not exist, or 409 if another update is already in progress on the stack. operationId: StartUpdateForDestroy parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppStartUpdateRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppStartUpdateResponse' description: OK '404': description: Update '409': description: Another update is currently in progress. summary: StartUpdateForDestroy tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/cancel: post: description: Requests cancellation of a service-managed update that is currently in progress. The update must have been started (returns 409 if it has not). Returns 404 if the specified update does not exist. The cancellation is processed asynchronously and the update will transition to a cancelled state. operationId: CancelUpdate_destroy parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string responses: '204': description: No Content '404': description: Update '409': description: The Update has not started summary: CancelUpdate tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/checkpoint: patch: description: Uploads a new checkpoint (deployment state snapshot) for a service-managed update that is currently in progress. The checkpoint contains the complete current state of all resources. The request must contain a valid checkpoint object. Returns 403 for preview operations since previews do not modify actual state. Returns 409 if the update has not started, has been cancelled, timed out, or already completed. Requires update token authentication. operationId: PatchUpdateCheckpoint_destroy parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppPatchUpdateCheckpointRequest' x-originalParamName: body responses: '204': description: No Content '400': description: request must contain a checkpoint or using the IsInvalid flag is not longer supported '403': description: Updating the checkpoint is not permitted for preview operations. '409': description: The Update has not started or The Update has been cancelled or The Update has already timed out or The Update has already completed summary: PatchUpdateCheckpoint tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/checkpointdelta: patch: description: Uploads a checkpoint delta for a service-managed update that is currently in progress. Rather than uploading the complete checkpoint state, this endpoint accepts an incremental delta that is applied to the existing checkpoint, reducing the payload size. The delta is persisted in the format as provided. Supports checksum validation for data integrity. Returns 403 for preview operations since previews do not modify actual state. Returns 409 if the update has not started, has been cancelled, timed out, or already completed. Requires update token authentication. operationId: PatchUpdateCheckpointDelta_destroy parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppPatchUpdateCheckpointDeltaRequest' x-originalParamName: body responses: '204': description: No Content '400': description: setting a checkpoint is not allowed because it's marked as already completed or failed to apply checkpoint delta or validating checksum '403': description: Updating the checkpoint is not permitted for preview operations. '409': description: The Update has not started or The Update has been cancelled or The Update has already timed out or The Update has already completed summary: PatchUpdateCheckpointDelta tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/checkpointverbatim: patch: description: Uploads a checkpoint for a service-managed update as a verbatim byte array, bypassing JSON marshalling. Unlike PatchUpdateCheckpoint which accepts a structured deployment object and re-serializes it (which may compact data), this endpoint preserves the exact bytes provided by the client and uploads them directly to blob storage. This maintains byte-level fidelity of the checkpoint data. Returns 403 for preview operations. Returns 409 if the update has not started, has been cancelled, timed out, or already completed. Requires update token authentication. operationId: PatchUpdateVerbatimCheckpoint_destroy parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppPatchUpdateVerbatimCheckpointRequest' x-originalParamName: body responses: '204': description: No Content '400': description: setting a checkpoint is not allowed because it's marked as already completed '403': description: Updating the checkpoint is not permitted for preview operations. '409': description: The Update has not started or The Update has been cancelled or The Update has already timed out or The Update has already completed summary: PatchUpdateVerbatimCheckpoint tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/complete: post: description: Marks a service-managed update as complete. The request body must include the final status of the update. Returns 400 if the status is unrecognized. Returns 409 if the update has not started, has been cancelled, has already timed out, or has already completed. Requires update token authentication. operationId: CompleteUpdate_destroy parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppCompleteUpdateRequest' x-originalParamName: body responses: '204': description: No Content '400': description: unrecognized status '404': description: Update '409': description: The Update has not started or The Update has been cancelled or The Update has already timed out or The Update has already completed summary: CompleteUpdate tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/events: get: description: Returns the engine events for the specified update. Engine events represent individual resource operations and diagnostic messages produced during the update. Supports pagination via continuation tokens and filtering by engine event type codes or resource URN. The include_non_activated parameter controls whether events not yet marked as activated are included. operationId: GetEngineEvents_destroy parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string - description: Continuation token for paginated results in: query name: continuationToken schema: type: string - description: When true, includes events that have not yet been activated; when false or omitted, only activated events are returned in: query name: include_non_activated schema: type: boolean - description: Filter results to only include events matching these engine event type codes in: query name: type schema: items: format: int64 type: integer type: array - description: Filter results to only include events for the specified resource URN in: query name: urn schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetUpdateEventsResponse' description: OK '400': description: Invalid continuation token. summary: GetEngineEvents tags: - Stacks post: description: Records a single engine event sent from the Pulumi CLI during a stack update. Engine events represent individual resource operations or diagnostic messages. For better performance, consider using RecordEngineEventBatch to send multiple events in a single request. Returns 400 if no event data is provided, or 404 if the update does not exist. Requires update token authentication. operationId: RecordEngineEvent_destroy parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppEngineEvent' x-originalParamName: body responses: '200': description: OK '400': description: No events provided. '404': description: Update summary: RecordEngineEvent tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/events/batch: post: description: Records a batch of engine events sent from the Pulumi CLI during a stack update. Engine events represent individual resource operations (create, update, delete, etc.) and diagnostic messages. Batching events reduces the number of API calls during an update. Returns 400 if no events are provided in the batch, or 404 if the update does not exist. Requires update token authentication. operationId: RecordEngineEventBatch_destroy parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppEngineEventBatch' x-originalParamName: body responses: '200': description: OK '400': description: No events provided. '404': description: Update summary: RecordEngineEventBatch tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/journalentries: patch: description: Creates new journal entries for the specified update. Journal entries record the progression of resource operations during an update, tracking state transitions for each resource. The include_non_activated query parameter controls whether non-activated events are included. Requires update token authentication. operationId: CreateJournalEntries_destroy parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string - description: When true, includes events that have not yet been activated; when false or omitted, only activated events are returned in: query name: include_non_activated schema: type: boolean requestBody: content: application/json: schema: $ref: '#/components/schemas/AppJournalEntries' x-originalParamName: body responses: '204': description: No Content summary: CreateJournalEntries tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/log: post: description: Appends a log entry to the specified update's log stream. Log entries are used to record diagnostic messages, status information, and other output generated during a stack update operation. Requires update token authentication. operationId: AppendUpdateLogEntry_destroy parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppAppendUpdateLogEntryRequest' x-originalParamName: body responses: '204': description: No Content summary: AppendUpdateLogEntry tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/renew_lease: post: description: Renews the lease for a service-managed update that is currently in progress. Leases prevent concurrent operations on the same stack and must be periodically renewed to indicate the update is still active. The renewal duration must be between 0 and 300 seconds. Returns 409 if the update is not currently in progress. operationId: RenewUpdateLease_destroy parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppRenewUpdateLeaseRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppRenewUpdateLeaseResponse' description: OK '400': description: Renewal duration must be between 0 and 300 seconds '409': description: The Update is not in progress. summary: RenewUpdateLease tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/downstreamreferences: get: description: Returns all stacks that reference the specified stack as a dependency in their Pulumi programs (via StackReference). This is useful for understanding the impact of changes to a stack, as downstream stacks may consume outputs from this stack. The response includes each referencing stack's organization, project, name, and version. operationId: ListDownstreamStackReferences parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListDownstreamStackReferencesResponse' description: OK summary: ListDownstreamStackReferences tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/encrypt: post: description: Encrypts a single plaintext value using the stack's encryption key. The request body contains the plaintext value to encrypt. The response contains the base64-encoded ciphertext. For encrypting multiple values in a single request, use the BatchEncryptValue endpoint instead. Returns 413 if the request body exceeds the maximum allowed content size. operationId: EncryptValue parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppEncryptValueRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppEncryptValueResponse' description: OK '413': description: Request Content Too Large summary: EncryptValue tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/export: get: description: Exports the current, complete state of the stack as an untyped deployment object. The response includes the deployment version, manifest (containing timestamps and plugin information), secrets providers configuration, and the full array of resources with their URNs, types, inputs, outputs, and dependency information. This endpoint is commonly used for stack state backup, migration between backends, or programmatic inspection of resource states. operationId: ExportStack parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppUntypedDeployment' description: OK summary: ExportStack tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/export/{version}: get: description: Exports the complete stack state at a specific historical update version, rather than the current version. This allows retrieving the deployment snapshot as it existed after a particular update completed. The response format is identical to the ExportStack endpoint. Returns 400 if the version parameter is invalid, or 404 if the specified version does not exist for this stack. operationId: ExportStackAtVersion parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The stack update version number in: path name: version required: true schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppUntypedDeployment' description: OK '400': description: invalid 'version' parameter '404': description: Stack Version summary: ExportStackAtVersion tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/hooks: get: description: Returns all webhooks configured for the specified stack. Each webhook in the response includes its name, display name, payload URL, format, filters, and active status. operationId: ListStackWebhooks parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/WebhookResponse' type: array description: successful operation summary: ListStackWebhooks tags: - Stacks post: description: 'Creates a new webhook for the specified stack. The request body must include the webhook name, payload URL, and format. The `format` field accepts: `raw` (default), `slack`, `ms_teams`, or `pulumi_deployments`. The `filters` field accepts a list of event types to subscribe to. See the [webhook event filtering documentation](https://www.pulumi.com/docs/pulumi-cloud/webhooks/#event-filtering) for available filters. The optional `secret` field sets the HMAC key for signature verification. See the [webhook headers documentation](https://www.pulumi.com/docs/pulumi-cloud/webhooks/#headers) for details. Returns 409 if a webhook with the same name already exists. Returns 400 if the organization or stack name in the request body does not match the URL path parameters.' operationId: CreateStackWebhook parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Webhook' x-originalParamName: body responses: '201': content: application/json: schema: $ref: '#/components/schemas/WebhookResponse' description: Created '400': description: Organization name from request body doesn't match URL or Stack name from request body doesn't match URL or invalid webhook name, display name, format, payload URL, groups, or filters. '409': description: Webhook with name {name} already exists. summary: CreateStackWebhook tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/hooks/{hookName}: delete: description: Deletes a webhook from the specified stack. Returns 204 with no content on success. operationId: DeleteStackWebhook parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The webhook name in: path name: hookName required: true schema: type: string responses: '204': description: No Content summary: DeleteStackWebhook tags: - Stacks get: description: Returns the details of a single webhook identified by its name, including its configuration, filters, groups, and active status. Returns 404 if the webhook does not exist. operationId: GetStackWebhook parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The webhook name in: path name: hookName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebhookResponse' description: OK '404': description: Webhook summary: GetStackWebhook tags: - Stacks patch: description: Updates an existing webhook's configuration. Supports modifying the display name, payload URL, format, groups, filters, and active status. The 'pulumi_deployments' format can only be used on stack or environment webhooks. Returns 404 if the webhook does not exist. operationId: UpdateStackWebhook parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The webhook name in: path name: hookName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Webhook' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebhookResponse' description: OK '400': description: '''pulumi_deployments'' format can only be used on stack or environment webhooks or Invalid display name, format, payload URL, groups, or filters.' '404': description: Webhook summary: UpdateStackWebhook tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/hooks/{hookName}/deliveries: get: description: Returns the recent delivery history for a specific webhook. Each delivery includes the timestamp, HTTP status code, request and response details, and whether the delivery was successful. operationId: GetStackWebhookDeliveries parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The webhook name in: path name: hookName required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/WebhookDelivery' type: array description: successful operation summary: GetStackWebhookDeliveries tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/hooks/{hookName}/deliveries/{event}/redeliver: post: description: Triggers the Pulumi Service to redeliver a specific event to a webhook. This is useful for resending an event that the webhook endpoint failed to process on the initial delivery attempt. Returns the delivery result with HTTP status and response details. Returns 404 if the webhook or event does not exist. operationId: RedeliverStackWebhookEvent parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The webhook name in: path name: hookName required: true schema: type: string - description: The webhook delivery event identifier to redeliver in: path name: event required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebhookDelivery' description: OK '404': description: Webhook or WebhookEvent summary: RedeliverStackWebhookEvent tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/hooks/{hookName}/ping: post: description: Issues a test ping event to the specified webhook to verify it is properly configured and reachable. Unlike normal webhook deliveries, this bypasses the message queue and sends the request directly to the webhook endpoint. The response includes the delivery result with HTTP status and response details. Returns 404 if the webhook does not exist. operationId: PingStackWebhook parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The webhook name in: path name: hookName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebhookDelivery' description: OK '404': description: Webhook summary: PingStackWebhook tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/import: post: description: Imports a deployment state snapshot into the specified stack, replacing the current state. The request body must contain a complete untyped deployment object with the same format returned by the ExportStack endpoint. This is commonly used for state migration between backends, state repair, or restoring from backup. Returns 400 if the deployment contains encrypted secrets from a different stack. Returns 409 if another update is currently in progress on the stack. operationId: ImportStack parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppImportStackRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppImportStackResponse' description: OK '400': description: cannot import deployment with encrypted secrets from a different stack '409': description: Another update is currently in progress. summary: ImportStack tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/metadata: get: description: Returns metadata about a stack including the requesting user's permission level and the stack's notification settings (such as whether to notify on update success or failure). This endpoint provides access control and configuration metadata without returning the full stack details. operationId: GetStackMetadata parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/StackMetadata' description: OK summary: GetStackMetadata tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/notifications/settings: patch: description: Updates the notification settings for a stack, controlling whether notifications are sent on update success or failure. The request body specifies the notification preferences. Returns the updated stack metadata including the new notification settings. operationId: UpdateStackNotificationSettings parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateStackNotificationSettingsRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/StackMetadata' description: OK summary: UpdateStackNotificationSettings tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/ownership: post: description: Changes the ownership of the specified stack to the provided user. Returns the identity of the previous owner. operationId: ReassignStackOwnership parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserInfo' description: The new owner's identity x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserInfo' description: OK summary: ReassignStackOwnership tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/policygroups: get: description: Returns the list of policy groups that include the specified stack. Policy groups define which policy packs are enforced on a set of stacks. The response includes each group's name, the stacks it applies to, and the policy packs configured within it. operationId: GetStackPolicyGroups parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppListPolicyGroupsResponse' description: OK summary: GetStackPolicyGroups tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/policypacks: get: description: 'Returns the policy packs currently enforced on the specified stack through its policy group memberships. The optional ''mode'' query parameter filters results by enforcement mode: ''audit'' (violations are logged but allowed) or ''preventative'' (violations block the update). Returns 400 if the mode parameter is invalid.' operationId: GetStackPolicyPacks parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: Filter by policy group enforcement mode ('audit' or 'preventative') in: query name: mode schema: enum: - audit - preventative type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppGetStackPolicyPacksResponse' description: OK '400': description: Invalid mode parameter value summary: GetStackPolicyPacks tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/preview: post: description: Creates a new preview update for the given stack. A preview shows what changes would be made without actually applying them, similar to a dry run. This only creates the update record; the update must subsequently be started via the StartUpdateForPreview endpoint. Enforces stack update concurrency checks. operationId: CreateUpdateForPreview parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUpdateProgramRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppUpdateProgramResponse' description: OK summary: CreateUpdateForPreview tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}: get: description: Returns the current status and results of a preview update, including whether it is still in progress, succeeded, or failed. Supports pagination of results via the continuationToken query parameter. operationId: GetUpdateStatusForPreview parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string - description: Continuation token for paginated results in: query name: continuationToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppUpdateResults' description: OK '400': description: invalid query parameter summary: GetUpdateStatusForPreview tags: - Stacks post: description: Starts execution of a previously created preview update. The update must have been created via CreateUpdateForPreview first. Returns a lease token and version number for tracking the update. Returns 404 if the update does not exist, or 409 if another update is already in progress on the stack. operationId: StartUpdateForPreview parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppStartUpdateRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppStartUpdateResponse' description: OK '404': description: Update '409': description: Another update is currently in progress. summary: StartUpdateForPreview tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/cancel: post: description: Requests cancellation of a service-managed update that is currently in progress. The update must have been started (returns 409 if it has not). Returns 404 if the specified update does not exist. The cancellation is processed asynchronously and the update will transition to a cancelled state. operationId: CancelUpdate_preview parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string responses: '204': description: No Content '404': description: Update '409': description: The Update has not started summary: CancelUpdate tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/complete: post: description: Marks a service-managed update as complete. The request body must include the final status of the update. Returns 400 if the status is unrecognized. Returns 409 if the update has not started, has been cancelled, has already timed out, or has already completed. Requires update token authentication. operationId: CompleteUpdate_preview parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppCompleteUpdateRequest' x-originalParamName: body responses: '204': description: No Content '400': description: unrecognized status '404': description: Update '409': description: The Update has not started or The Update has been cancelled or The Update has already timed out or The Update has already completed summary: CompleteUpdate tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/events: get: description: Returns the engine events for the specified update. Engine events represent individual resource operations and diagnostic messages produced during the update. Supports pagination via continuation tokens and filtering by engine event type codes or resource URN. The include_non_activated parameter controls whether events not yet marked as activated are included. operationId: GetEngineEvents_preview parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string - description: Continuation token for paginated results in: query name: continuationToken schema: type: string - description: When true, includes events that have not yet been activated; when false or omitted, only activated events are returned in: query name: include_non_activated schema: type: boolean - description: Filter results to only include events matching these engine event type codes in: query name: type schema: items: format: int64 type: integer type: array - description: Filter results to only include events for the specified resource URN in: query name: urn schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetUpdateEventsResponse' description: OK '400': description: Invalid continuation token. summary: GetEngineEvents tags: - Stacks post: description: Records a single engine event sent from the Pulumi CLI during a stack update. Engine events represent individual resource operations or diagnostic messages. For better performance, consider using RecordEngineEventBatch to send multiple events in a single request. Returns 400 if no event data is provided, or 404 if the update does not exist. Requires update token authentication. operationId: RecordEngineEvent_preview parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppEngineEvent' x-originalParamName: body responses: '200': description: OK '400': description: No events provided. '404': description: Update summary: RecordEngineEvent tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/events/batch: post: description: Records a batch of engine events sent from the Pulumi CLI during a stack update. Engine events represent individual resource operations (create, update, delete, etc.) and diagnostic messages. Batching events reduces the number of API calls during an update. Returns 400 if no events are provided in the batch, or 404 if the update does not exist. Requires update token authentication. operationId: RecordEngineEventBatch_preview parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppEngineEventBatch' x-originalParamName: body responses: '200': description: OK '400': description: No events provided. '404': description: Update summary: RecordEngineEventBatch tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/journalentries: patch: description: Creates new journal entries for the specified update. Journal entries record the progression of resource operations during an update, tracking state transitions for each resource. The include_non_activated query parameter controls whether non-activated events are included. Requires update token authentication. operationId: CreateJournalEntries_preview parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string - description: When true, includes events that have not yet been activated; when false or omitted, only activated events are returned in: query name: include_non_activated schema: type: boolean requestBody: content: application/json: schema: $ref: '#/components/schemas/AppJournalEntries' x-originalParamName: body responses: '204': description: No Content summary: CreateJournalEntries tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/log: post: description: Appends a log entry to the specified update's log stream. Log entries are used to record diagnostic messages, status information, and other output generated during a stack update operation. Requires update token authentication. operationId: AppendUpdateLogEntry_preview parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppAppendUpdateLogEntryRequest' x-originalParamName: body responses: '204': description: No Content summary: AppendUpdateLogEntry tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/renew_lease: post: description: Renews the lease for a service-managed update that is currently in progress. Leases prevent concurrent operations on the same stack and must be periodically renewed to indicate the update is still active. The renewal duration must be between 0 and 300 seconds. Returns 409 if the update is not currently in progress. operationId: RenewUpdateLease_preview parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppRenewUpdateLeaseRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppRenewUpdateLeaseResponse' description: OK '400': description: Renewal duration must be between 0 and 300 seconds '409': description: The Update is not in progress. summary: RenewUpdateLease tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/previews/{updateID}: get: description: Returns details of a specific preview operation identified by its update ID. The response includes the preview's kind, start and end times, result status, resource changes summary, configuration, and environment details. Returns 404 if the specified update does not exist. operationId: GetStackPreview parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdateInfo' description: OK '404': description: Update summary: GetStackPreview tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/previews/{updateID}/summary: get: description: Returns a concise summary of a specific preview operation, including the update kind, result status, start and end times, and resource change counts. This is a lighter-weight alternative to GetStackPreview when full update details are not needed. Returns 404 if the specified update does not exist. operationId: GetStackPreviewSummary parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdateSummary' description: OK '404': description: Update summary: GetStackPreviewSummary tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/refresh: post: description: Creates a new refresh update for the given stack. A refresh synchronizes the stack's state with the actual state of the cloud resources, detecting any drift. This only creates the update record; the update must subsequently be started via the StartUpdateForRefresh endpoint. Enforces stack update concurrency checks. operationId: CreateUpdateForRefresh parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUpdateProgramRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppUpdateProgramResponse' description: OK summary: CreateUpdateForRefresh tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}: get: description: Returns the current status and results of a refresh update, including whether it is still in progress, succeeded, or failed. Supports pagination of results via the continuationToken query parameter. operationId: GetUpdateStatusForRefresh parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string - description: Continuation token for paginated results in: query name: continuationToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppUpdateResults' description: OK '400': description: invalid query parameter summary: GetUpdateStatusForRefresh tags: - Stacks post: description: Starts execution of a previously created refresh update. The update must have been created via CreateUpdateForRefresh first. Returns a lease token and version number for tracking the update. Returns 404 if the update does not exist, or 409 if another update is already in progress on the stack. operationId: StartUpdateForRefresh parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppStartUpdateRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppStartUpdateResponse' description: OK '404': description: Update '409': description: Another update is currently in progress. summary: StartUpdateForRefresh tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/cancel: post: description: Requests cancellation of a service-managed update that is currently in progress. The update must have been started (returns 409 if it has not). Returns 404 if the specified update does not exist. The cancellation is processed asynchronously and the update will transition to a cancelled state. operationId: CancelUpdate_refresh parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string responses: '204': description: No Content '404': description: Update '409': description: The Update has not started summary: CancelUpdate tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/checkpoint: patch: description: Uploads a new checkpoint (deployment state snapshot) for a service-managed update that is currently in progress. The checkpoint contains the complete current state of all resources. The request must contain a valid checkpoint object. Returns 403 for preview operations since previews do not modify actual state. Returns 409 if the update has not started, has been cancelled, timed out, or already completed. Requires update token authentication. operationId: PatchUpdateCheckpoint_refresh parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppPatchUpdateCheckpointRequest' x-originalParamName: body responses: '204': description: No Content '400': description: request must contain a checkpoint or using the IsInvalid flag is not longer supported '403': description: Updating the checkpoint is not permitted for preview operations. '409': description: The Update has not started or The Update has been cancelled or The Update has already timed out or The Update has already completed summary: PatchUpdateCheckpoint tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/checkpointdelta: patch: description: Uploads a checkpoint delta for a service-managed update that is currently in progress. Rather than uploading the complete checkpoint state, this endpoint accepts an incremental delta that is applied to the existing checkpoint, reducing the payload size. The delta is persisted in the format as provided. Supports checksum validation for data integrity. Returns 403 for preview operations since previews do not modify actual state. Returns 409 if the update has not started, has been cancelled, timed out, or already completed. Requires update token authentication. operationId: PatchUpdateCheckpointDelta_refresh parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppPatchUpdateCheckpointDeltaRequest' x-originalParamName: body responses: '204': description: No Content '400': description: setting a checkpoint is not allowed because it's marked as already completed or failed to apply checkpoint delta or validating checksum '403': description: Updating the checkpoint is not permitted for preview operations. '409': description: The Update has not started or The Update has been cancelled or The Update has already timed out or The Update has already completed summary: PatchUpdateCheckpointDelta tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/checkpointverbatim: patch: description: Uploads a checkpoint for a service-managed update as a verbatim byte array, bypassing JSON marshalling. Unlike PatchUpdateCheckpoint which accepts a structured deployment object and re-serializes it (which may compact data), this endpoint preserves the exact bytes provided by the client and uploads them directly to blob storage. This maintains byte-level fidelity of the checkpoint data. Returns 403 for preview operations. Returns 409 if the update has not started, has been cancelled, timed out, or already completed. Requires update token authentication. operationId: PatchUpdateVerbatimCheckpoint_refresh parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppPatchUpdateVerbatimCheckpointRequest' x-originalParamName: body responses: '204': description: No Content '400': description: setting a checkpoint is not allowed because it's marked as already completed '403': description: Updating the checkpoint is not permitted for preview operations. '409': description: The Update has not started or The Update has been cancelled or The Update has already timed out or The Update has already completed summary: PatchUpdateVerbatimCheckpoint tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/complete: post: description: Marks a service-managed update as complete. The request body must include the final status of the update. Returns 400 if the status is unrecognized. Returns 409 if the update has not started, has been cancelled, has already timed out, or has already completed. Requires update token authentication. operationId: CompleteUpdate_refresh parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppCompleteUpdateRequest' x-originalParamName: body responses: '204': description: No Content '400': description: unrecognized status '404': description: Update '409': description: The Update has not started or The Update has been cancelled or The Update has already timed out or The Update has already completed summary: CompleteUpdate tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/events: get: description: Returns the engine events for the specified update. Engine events represent individual resource operations and diagnostic messages produced during the update. Supports pagination via continuation tokens and filtering by engine event type codes or resource URN. The include_non_activated parameter controls whether events not yet marked as activated are included. operationId: GetEngineEvents_refresh parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string - description: Continuation token for paginated results in: query name: continuationToken schema: type: string - description: When true, includes events that have not yet been activated; when false or omitted, only activated events are returned in: query name: include_non_activated schema: type: boolean - description: Filter results to only include events matching these engine event type codes in: query name: type schema: items: format: int64 type: integer type: array - description: Filter results to only include events for the specified resource URN in: query name: urn schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetUpdateEventsResponse' description: OK '400': description: Invalid continuation token. summary: GetEngineEvents tags: - Stacks post: description: Records a single engine event sent from the Pulumi CLI during a stack update. Engine events represent individual resource operations or diagnostic messages. For better performance, consider using RecordEngineEventBatch to send multiple events in a single request. Returns 400 if no event data is provided, or 404 if the update does not exist. Requires update token authentication. operationId: RecordEngineEvent_refresh parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppEngineEvent' x-originalParamName: body responses: '200': description: OK '400': description: No events provided. '404': description: Update summary: RecordEngineEvent tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/events/batch: post: description: Records a batch of engine events sent from the Pulumi CLI during a stack update. Engine events represent individual resource operations (create, update, delete, etc.) and diagnostic messages. Batching events reduces the number of API calls during an update. Returns 400 if no events are provided in the batch, or 404 if the update does not exist. Requires update token authentication. operationId: RecordEngineEventBatch_refresh parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppEngineEventBatch' x-originalParamName: body responses: '200': description: OK '400': description: No events provided. '404': description: Update summary: RecordEngineEventBatch tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/journalentries: patch: description: Creates new journal entries for the specified update. Journal entries record the progression of resource operations during an update, tracking state transitions for each resource. The include_non_activated query parameter controls whether non-activated events are included. Requires update token authentication. operationId: CreateJournalEntries_refresh parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string - description: When true, includes events that have not yet been activated; when false or omitted, only activated events are returned in: query name: include_non_activated schema: type: boolean requestBody: content: application/json: schema: $ref: '#/components/schemas/AppJournalEntries' x-originalParamName: body responses: '204': description: No Content summary: CreateJournalEntries tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/log: post: description: Appends a log entry to the specified update's log stream. Log entries are used to record diagnostic messages, status information, and other output generated during a stack update operation. Requires update token authentication. operationId: AppendUpdateLogEntry_refresh parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppAppendUpdateLogEntryRequest' x-originalParamName: body responses: '204': description: No Content summary: AppendUpdateLogEntry tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/renew_lease: post: description: Renews the lease for a service-managed update that is currently in progress. Leases prevent concurrent operations on the same stack and must be periodically renewed to indicate the update is still active. The renewal duration must be between 0 and 300 seconds. Returns 409 if the update is not currently in progress. operationId: RenewUpdateLease_refresh parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppRenewUpdateLeaseRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppRenewUpdateLeaseResponse' description: OK '400': description: Renewal duration must be between 0 and 300 seconds '409': description: The Update is not in progress. summary: RenewUpdateLease tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/rename: post: description: Changes an existing stack's name to a new value. The request body must include the desired new name. The rename may also change the project name. Returns 400 if the request body does not specify a rename. Returns 409 if another update is currently in progress on the stack, since renaming requires exclusive access. operationId: RenameStack parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppStackRenameRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppImportStackResponse' description: OK '400': description: No rename to apply. '409': description: Another update is currently in progress. summary: RenameStack tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/resources/count: get: description: Returns the total number of resources currently managed by the stack, based on the most recent update. The response includes the resource count and the stack version number. This is a lightweight endpoint for checking stack size without retrieving full resource details. operationId: GetStackResourceCount parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetStackResourceCountResponse' description: OK summary: GetStackResourceCount tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/resources/latest: get: description: Retrieves all resources currently managed by the stack from the most recent update. Each resource in the response includes its type, URN, provider, inputs, outputs, parent, and dependencies. This is equivalent to calling GetStackResources with the latest version number. operationId: GetLatestStackResources parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetStackResourcesResponse' description: OK summary: GetLatestStackResources tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/resources/latest/{urn}: get: description: Returns detailed information about a specific resource identified by its URN from the most recent stack update. The response includes the resource type, provider, inputs, outputs, and dependency information. Returns 404 if no resource with the given URN exists in the latest state. operationId: GetLatestStackResource parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The resource URN in: path name: urn required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetStackResourceResponse' description: OK '404': description: Resource summary: GetLatestStackResource tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/resources/{version}: get: description: Retrieves all resources as they existed at a specific historical stack update version. Each resource includes its type, URN, provider, inputs, outputs, parent, and dependencies. Returns 404 if the specified version does not exist for this stack. operationId: GetStackResources parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The stack update version number in: path name: version required: true schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetStackResourcesResponse' description: OK '404': description: Version summary: GetStackResources tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/resources/{version}/{urn}: get: description: Returns detailed information about a specific resource identified by its URN at a specific historical update version. The response includes the resource type, provider, inputs, outputs, and dependency information as they existed at that version. Returns 404 if the resource or version does not exist. operationId: GetStackResource parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The stack update version number in: path name: version required: true schema: format: int64 type: integer - description: The resource URN in: path name: urn required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetStackResourceResponse' description: OK '404': description: Resource or Version summary: GetStackResource tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/tags: patch: description: 'Replaces all tags on the specified stack with the tags provided in the request body. This is a wholesale replacement operation: any existing tags not included in the request will be removed. The request body is a JSON map of tag name-value pairs. Returns 400 if the operation would change the project name tag or if any tags are invalid.' operationId: UpdateStackTags parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: additionalProperties: type: string type: object x-originalParamName: body responses: '204': description: No Content '400': description: Cannot change project's name or tags are invalid summary: UpdateStackTags tags: - Stacks post: description: Creates a new tag on the specified stack. Tags are key-value metadata pairs that can be used for organization, filtering, and storing additional information about stacks. The request body must include both a tag name and value. Returns 400 if the tag name is invalid or the tag already exists. Built-in tags (such as those automatically set by the Pulumi CLI) follow specific naming conventions. operationId: AddStackTag parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/StackTag' x-originalParamName: body responses: '204': description: No Content '400': description: Invalid tag name or tag already exists. summary: AddStackTag tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/tags/{tagName}: delete: description: Removes a specific tag from the stack, identified by the tag name in the URL path. Built-in tags (those automatically managed by the Pulumi CLI) cannot be deleted and will return a 400 error. Returns 404 if the specified tag does not exist on the stack. Returns 204 with no content on success. operationId: DeleteStackTag parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The tag name in: path name: tagName required: true schema: type: string responses: '204': description: No Content '400': description: built-in tags cannot be deleted '404': description: Tag not found summary: DeleteStackTag tags: - Stacks patch: description: Updates the value of an existing tag on the specified stack. The tag is identified by its name in the URL path. Built-in tags (those automatically managed by the Pulumi CLI, such as project name tags) cannot be updated and will return a 400 error. Returns 404 if the specified tag does not exist on the stack. operationId: UpdateStackTag parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The tag name in: path name: tagName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/StackTag' x-originalParamName: body responses: '204': description: No Content '400': description: built-in tags cannot be updated or invalid tag name '404': description: tag not found summary: UpdateStackTag tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/teams: get: description: Lists all teams within the organization that have been granted access to the specified stack. The response includes each team's name and the permission level granted to it for this stack. operationId: ListStackTeams parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListTeamsByStackResponse' description: OK summary: ListStackTeams tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/transfer: post: description: Transfers a stack from one organization to another. The request body must specify the destination organization name via the 'toOrg' field. The requesting user must be a member of both the source and destination organizations to prevent accidental disclosure of organization existence. The stack must not have any active updates in progress (returns 409 if an update is running). Returns 204 with no content on success. operationId: TransferStack parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TransferStackRequest' x-originalParamName: body responses: '204': description: No Content '409': description: Another update is currently in progress. summary: TransferStack tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/update: post: description: Creates a new standard update (pulumi up) for the given stack. A standard update deploys changes to the stack's infrastructure by creating, updating, or deleting resources as needed. This only creates the update record; the update must subsequently be started via the StartUpdateForUpdate endpoint. Enforces stack update concurrency checks to prevent conflicting simultaneous operations. operationId: CreateUpdateForUpdate parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUpdateProgramRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppUpdateProgramResponse' description: OK summary: CreateUpdateForUpdate tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}: get: description: Returns the current status and results of a standard (pulumi up) update, including whether it is still in progress, succeeded, or failed. Supports pagination of results via the continuationToken query parameter. operationId: GetUpdateStatusForUpdate parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string - description: Continuation token for paginated results in: query name: continuationToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppUpdateResults' description: OK '400': description: invalid query parameter summary: GetUpdateStatusForUpdate tags: - Stacks post: description: Starts execution of a previously created standard (pulumi up) update. The update must have been created via CreateUpdateForUpdate first. Returns a lease token and version number for tracking the update. Returns 404 if the update does not exist, or 409 if another update is already in progress on the stack. operationId: StartUpdateForUpdate parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppStartUpdateRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppStartUpdateResponse' description: OK '404': description: Update '409': description: Another update is currently in progress. summary: StartUpdateForUpdate tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/cancel: post: description: Requests cancellation of a service-managed update that is currently in progress. The update must have been started (returns 409 if it has not). Returns 404 if the specified update does not exist. The cancellation is processed asynchronously and the update will transition to a cancelled state. operationId: CancelUpdate_update parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string responses: '204': description: No Content '404': description: Update '409': description: The Update has not started summary: CancelUpdate tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/checkpoint: patch: description: Uploads a new checkpoint (deployment state snapshot) for a service-managed update that is currently in progress. The checkpoint contains the complete current state of all resources. The request must contain a valid checkpoint object. Returns 403 for preview operations since previews do not modify actual state. Returns 409 if the update has not started, has been cancelled, timed out, or already completed. Requires update token authentication. operationId: PatchUpdateCheckpoint_update parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppPatchUpdateCheckpointRequest' x-originalParamName: body responses: '204': description: No Content '400': description: request must contain a checkpoint or using the IsInvalid flag is not longer supported '403': description: Updating the checkpoint is not permitted for preview operations. '409': description: The Update has not started or The Update has been cancelled or The Update has already timed out or The Update has already completed summary: PatchUpdateCheckpoint tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/checkpointdelta: patch: description: Uploads a checkpoint delta for a service-managed update that is currently in progress. Rather than uploading the complete checkpoint state, this endpoint accepts an incremental delta that is applied to the existing checkpoint, reducing the payload size. The delta is persisted in the format as provided. Supports checksum validation for data integrity. Returns 403 for preview operations since previews do not modify actual state. Returns 409 if the update has not started, has been cancelled, timed out, or already completed. Requires update token authentication. operationId: PatchUpdateCheckpointDelta_update parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppPatchUpdateCheckpointDeltaRequest' x-originalParamName: body responses: '204': description: No Content '400': description: setting a checkpoint is not allowed because it's marked as already completed or failed to apply checkpoint delta or validating checksum '403': description: Updating the checkpoint is not permitted for preview operations. '409': description: The Update has not started or The Update has been cancelled or The Update has already timed out or The Update has already completed summary: PatchUpdateCheckpointDelta tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/checkpointverbatim: patch: description: Uploads a checkpoint for a service-managed update as a verbatim byte array, bypassing JSON marshalling. Unlike PatchUpdateCheckpoint which accepts a structured deployment object and re-serializes it (which may compact data), this endpoint preserves the exact bytes provided by the client and uploads them directly to blob storage. This maintains byte-level fidelity of the checkpoint data. Returns 403 for preview operations. Returns 409 if the update has not started, has been cancelled, timed out, or already completed. Requires update token authentication. operationId: PatchUpdateVerbatimCheckpoint_update parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppPatchUpdateVerbatimCheckpointRequest' x-originalParamName: body responses: '204': description: No Content '400': description: setting a checkpoint is not allowed because it's marked as already completed '403': description: Updating the checkpoint is not permitted for preview operations. '409': description: The Update has not started or The Update has been cancelled or The Update has already timed out or The Update has already completed summary: PatchUpdateVerbatimCheckpoint tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/complete: post: description: Marks a service-managed update as complete. The request body must include the final status of the update. Returns 400 if the status is unrecognized. Returns 409 if the update has not started, has been cancelled, has already timed out, or has already completed. Requires update token authentication. operationId: CompleteUpdate_update parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppCompleteUpdateRequest' x-originalParamName: body responses: '204': description: No Content '400': description: unrecognized status '404': description: Update '409': description: The Update has not started or The Update has been cancelled or The Update has already timed out or The Update has already completed summary: CompleteUpdate tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/events: get: description: Returns the engine events for the specified update. Engine events represent individual resource operations and diagnostic messages produced during the update. Supports pagination via continuation tokens and filtering by engine event type codes or resource URN. The include_non_activated parameter controls whether events not yet marked as activated are included. operationId: GetEngineEvents_update parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string - description: Continuation token for paginated results in: query name: continuationToken schema: type: string - description: When true, includes events that have not yet been activated; when false or omitted, only activated events are returned in: query name: include_non_activated schema: type: boolean - description: Filter results to only include events matching these engine event type codes in: query name: type schema: items: format: int64 type: integer type: array - description: Filter results to only include events for the specified resource URN in: query name: urn schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetUpdateEventsResponse' description: OK '400': description: Invalid continuation token. summary: GetEngineEvents tags: - Stacks post: description: Records a single engine event sent from the Pulumi CLI during a stack update. Engine events represent individual resource operations or diagnostic messages. For better performance, consider using RecordEngineEventBatch to send multiple events in a single request. Returns 400 if no event data is provided, or 404 if the update does not exist. Requires update token authentication. operationId: RecordEngineEvent_update parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppEngineEvent' x-originalParamName: body responses: '200': description: OK '400': description: No events provided. '404': description: Update summary: RecordEngineEvent tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/events/batch: post: description: Records a batch of engine events sent from the Pulumi CLI during a stack update. Engine events represent individual resource operations (create, update, delete, etc.) and diagnostic messages. Batching events reduces the number of API calls during an update. Returns 400 if no events are provided in the batch, or 404 if the update does not exist. Requires update token authentication. operationId: RecordEngineEventBatch_update parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppEngineEventBatch' x-originalParamName: body responses: '200': description: OK '400': description: No events provided. '404': description: Update summary: RecordEngineEventBatch tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/journalentries: patch: description: Creates new journal entries for the specified update. Journal entries record the progression of resource operations during an update, tracking state transitions for each resource. The include_non_activated query parameter controls whether non-activated events are included. Requires update token authentication. operationId: CreateJournalEntries_update parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string - description: When true, includes events that have not yet been activated; when false or omitted, only activated events are returned in: query name: include_non_activated schema: type: boolean requestBody: content: application/json: schema: $ref: '#/components/schemas/AppJournalEntries' x-originalParamName: body responses: '204': description: No Content summary: CreateJournalEntries tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/log: post: description: Appends a log entry to the specified update's log stream. Log entries are used to record diagnostic messages, status information, and other output generated during a stack update operation. Requires update token authentication. operationId: AppendUpdateLogEntry_update parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppAppendUpdateLogEntryRequest' x-originalParamName: body responses: '204': description: No Content summary: AppendUpdateLogEntry tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/renew_lease: post: description: Renews the lease for a service-managed update that is currently in progress. Leases prevent concurrent operations on the same stack and must be periodically renewed to indicate the update is still active. The renewal duration must be between 0 and 300 seconds. Returns 409 if the update is not currently in progress. operationId: RenewUpdateLease_update parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The update ID in: path name: updateID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppRenewUpdateLeaseRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppRenewUpdateLeaseResponse' description: OK '400': description: Renewal duration must be between 0 and 300 seconds '409': description: The Update is not in progress. summary: RenewUpdateLease tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/updates: get: description: 'Returns the update history for a stack. Each update includes its kind (update, preview, refresh, destroy, import), start and end times, result status, resource changes summary, and resource count. Supports pagination via ''page'' and ''pageSize'' query parameters (page 0 returns all results, pageSize=1 with page=1 returns only the most recent update). The ''output-type'' parameter controls the response format: when unset, returns a legacy format; when set, returns a paginated response.' operationId: GetStackUpdates parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: Controls the response format; when unset returns the legacy format, otherwise returns the paginated format in: query name: output-type schema: type: string - description: Page number for paginated results (0-indexed, where 0 returns all results) in: query name: page schema: format: int64 type: integer - description: Number of results per page (must be >= 1 when page > 0) in: query name: pageSize schema: format: int64 type: integer responses: '200': content: application/json: schema: type: object description: OK '400': description: Invalid 'page' value. or Invalid 'pageSize' value. summary: GetStackUpdates tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/updates/latest: get: description: Returns information about the most recent update to the stack, including the update kind (update, preview, refresh, destroy, import), start and end times, result status, resource changes summary, configuration, and environment details. Returns 404 if the stack has never been updated. operationId: GetLatestStackUpdate parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdateInfo' description: OK '404': description: Version summary: GetLatestStackUpdate tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/updates/latest/previews: get: description: Returns all preview operations associated with the latest stack update version. Previews are dry-run operations that show what changes would be made. Supports pagination via page and pageSize parameters (page 0 returns all results). The asc parameter controls sort order (ascending or descending by chronological order). operationId: GetLatestStackPreviews parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: When true, sorts results in ascending chronological order; when false or omitted, sorts in descending order in: query name: asc schema: type: boolean - description: Page number for paginated results (0-indexed, where 0 returns all results) in: query name: page schema: format: int64 type: integer - description: Number of results per page (must be >= 1 when page > 0) in: query name: pageSize schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetStackUpdatesResponse' description: OK '400': description: Invalid 'page' value. Must be >= 0. or Invalid 'pageSize' value. Must be >= 1. or Invalid 'pageSize' value. Must be 0 or unset when 'page' is 0. summary: GetLatestStackPreviews tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/updates/latest/timeline: get: description: Returns the timeline of all relevant events culminating with the most recent stack update. The timeline includes workflow events such as deployment triggers, previews, and the final update operation, providing a complete view of the sequence of actions that led to the current stack state. Returns 404 if no update exists. operationId: GetLatestUpdateTimeline parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetUpdateTimelineResponse' description: OK '404': description: Stack Update summary: GetLatestUpdateTimeline tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/updates/{version}: get: description: Returns detailed information about a specific stack update identified by its version number. The response includes the update kind (update, preview, refresh, destroy, import), start and end times, result status (succeeded, failed, etc.), resource changes summary (creates, updates, deletes, same), configuration, and environment details. Returns 404 if the specified version does not exist. operationId: GetStackUpdate parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The stack update version number in: path name: version required: true schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdateInfo' description: OK '404': description: Version summary: GetStackUpdate tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/updates/{version}/previews: get: description: Returns all preview operations associated with a specific stack update version. Multiple previews may be associated with a single update version when a stack is previewed multiple times before an update is applied. Supports pagination via page and pageSize parameters and chronological sorting via the asc parameter. operationId: GetStackPreviews parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The stack update version number in: path name: version required: true schema: format: int64 type: integer - description: When true, sorts results in ascending chronological order; when false or omitted, sorts in descending order in: query name: asc schema: type: boolean - description: Page number for paginated results (0-indexed, where 0 returns all results) in: query name: page schema: format: int64 type: integer - description: Number of results per page (must be >= 1 when page > 0) in: query name: pageSize schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetStackUpdatesResponse' description: OK '400': description: Invalid 'page' value. Must be >= 0. or Invalid 'pageSize' value. Must be >= 1. or Invalid 'pageSize' value. Must be 0 or unset when 'page' is 0. summary: GetStackPreviews tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/updates/{version}/summary: get: description: Returns a concise summary of a specific stack update by version number, including the update kind, result status, start and end times, and resource change counts. This is a lighter-weight alternative to GetStackUpdate when full update details are not needed. Returns 404 if the specified version does not exist. operationId: GetStackUpdateSummary parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The stack update version number in: path name: version required: true schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdateSummary' description: OK '404': description: Version summary: GetStackUpdateSummary tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/updates/{version}/timeline: get: description: Returns the timeline of all relevant events culminating with a specific stack update version. The timeline includes workflow events such as deployment triggers, previews, and the update operation itself, providing a complete view of the sequence of actions. Returns 404 if the specified update version does not exist. operationId: GetUpdateTimeline parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string - description: The stack update version number in: path name: version required: true schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetUpdateTimelineResponse' description: OK '404': description: Stack Update summary: GetUpdateTimeline tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/upstreamreferences: get: description: Returns all stacks that the specified stack references as dependencies in its Pulumi program (via StackReference). This is useful for understanding what external stacks a given stack depends on and consumes outputs from. The response includes each referenced stack's organization, project, name, and version. operationId: ListUpstreamStackReferences parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListDownstreamStackReferencesResponse' description: OK summary: ListUpstreamStackReferences tags: - Stacks /api/stacks/{orgName}/{projectName}/{stackName}/workflow: post: description: Generates a customized CI/CD workflow template for the specified stack. The request body must specify the target CI system (e.g. GitHub Actions, GitLab CI). The generated template is tailored to the stack's runtime and configuration. Returns 400 if the CI system is not specified or the stack does not have a runtime tag. Returns 404 if no matching workflow template is found. operationId: GetStackStarterWorkflow parameters: - description: The organization name in: path name: orgName required: true schema: type: string - description: The project name in: path name: projectName required: true schema: type: string - description: The stack name in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GetStarterWorkflowRequest' x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetStackStarterWorkflowResponse' description: OK '400': description: CISystem must be specified or Stack does not have a runtime tag '404': description: WorkflowTemplate summary: GetStackStarterWorkflow tags: - Stacks components: schemas: AppUpdateInfo: description: 'UpdateInfo describes a previous update. Should generally mirror backend.UpdateInfo, but we clone it in this package to add flexibility in case there is a breaking change in the backend-type.' properties: config: additionalProperties: $ref: '#/components/schemas/AppConfigValue' description: Stack configuration values used during the update, keyed by config key. type: object x-order: 5 deployment: description: Raw deployment state snapshot, if requested. type: object x-order: 9 endTime: description: Unix epoch timestamp (seconds) when the update completed. format: int64 type: integer x-order: 7 environment: additionalProperties: type: string description: Environment variables that were set during the update, keyed by variable name. type: object x-order: 4 kind: description: Information known before an update is started. enum: - update - preview - refresh - rename - destroy - import - Pupdate - Prefresh - Pdestroy - Pimport - Prename type: string x-order: 1 x-pulumi-model-property: enumTypeName: AppUpdateKind enumComments: 'UpdateKind is an enum for the type of update performed. Should generally mirror backend.UpdateKind, but we clone it in this package to add flexibility in case there is a breaking change in the backend-type.' enumFieldNames: - Update - Preview - Refresh - Rename - Destroy - Import - PreviewUpdate - PreviewRefresh - PreviewDestroy - PreviewImport - PreviewRename enumFieldComments: - A Pulumi program update. - A preview of an update, without impacting resources. - A refresh operation. - 'A rename of the stack or project name. NOTE: Do not remove this type - it is used by Pulumi Cloud code.' - An update which removes all resources. - An update that entails importing a raw checkpoint file. - A preview of an update operation. - A preview of a refresh operation. - A preview of a destroy operation. - A preview of an import operation. - A preview of a rename operation. message: description: User-provided message describing the purpose of the update. type: string x-order: 3 resourceChanges: additionalProperties: format: int64 type: integer description: 'Count of resource changes by operation type (e.g. ''create'': 5, ''update'': 2, ''delete'': 1).' type: object x-order: 10 resourceCount: description: Total number of resources managed by the stack after this update. format: int64 type: integer x-order: 11 result: description: Information obtained from an update completing. enum: - not-started - in-progress - succeeded - failed type: string x-order: 6 x-pulumi-model-property: enumTypeName: AppUpdateResult enumComments: 'UpdateResult is an enum for the result of the update. Should generally mirror backend.UpdateResult, but we clone it in this package to add flexibility in case there is a breaking change in the backend-type.' enumFieldNames: - NotStarted - InProgress - Succeeded - Failed enumFieldComments: - The update has not started. - The update has not yet completed. - The update completed successfully. - The update has failed. startTime: description: Unix epoch timestamp (seconds) when the update started. format: int64 type: integer x-order: 2 version: description: The stack version after this update completed. format: int64 type: integer x-order: 8 required: - config - endTime - environment - kind - message - result - startTime - version type: object TransferStackRequest: description: TransferStackRequest request object for `transferring` ownership of a stack between two organizations. properties: fromOrg: description: The source organization to transfer the stack from. If unset, the organization from the URL route parameters is used. type: string x-order: 3 projectName: description: The project name of the stack to transfer. If unset, the project from the URL route parameters is used. type: string x-order: 1 stackName: description: The name of the stack to transfer. If unset, the stack from the URL route parameters is used. type: string x-order: 2 toOrg: description: The organization to transfer the stack to. type: string x-order: 4 required: - toOrg type: object GetStackResourceResponse: description: GetStackResourceResponse returns a single resource for a stack at a particular update. properties: region: description: The cloud region where the resource is deployed type: string x-order: 2 resource: $ref: '#/components/schemas/ResourceInfo' description: The resource information x-order: 1 version: description: The update version number format: int64 type: integer x-order: 3 required: - region - resource - version type: object DeploymentSource: description: DeploymentSource describes the source of a deployment, which may be a Git repository or a template. properties: git: $ref: '#/components/schemas/DeploymentSourceGit' description: The Git source configuration for the deployment. x-order: 1 template: $ref: '#/components/schemas/DeploymentSourceTemplate' description: The template source configuration for the deployment. x-order: 2 type: object AppPolicyRemediateSummaryEvent: description: PolicyRemediateSummaryEvent is emitted after a call to Remediate on an analyzer, summarizing the results. properties: failed: description: The names of resource policies that failed (i.e. produced violations). items: type: string type: array x-order: 6 passed: description: The names of resource policies that passed (i.e. did not produce any violations). items: type: string type: array x-order: 5 policyPackName: description: The name of the policy pack. type: string x-order: 2 policyPackVersion: description: The version of the policy pack. type: string x-order: 3 policyPackVersionTag: description: The version tag of the policy pack. type: string x-order: 4 resourceUrn: description: The URN of the resource being remediated. type: string x-order: 1 required: - policyPackName - policyPackVersion - policyPackVersionTag - resourceUrn type: object EnvironmentVariable: description: EnvironmentVariable is a key-value pair; if the variable is secret, value will be empty/omitted. properties: name: description: The name of the environment variable. type: string x-order: 1 secret: description: Whether the environment variable contains a secret value. type: boolean x-order: 3 value: description: The value of the environment variable. Empty or omitted if the variable is secret. type: string x-order: 2 required: - name - secret type: object GetStackStarterWorkflowResponse: description: Response body for retrieving a starter workflow for a stack. properties: content: description: The starter workflow content type: string x-order: 1 required: - content type: object AppBatchEncryptRequest: description: BatchEncryptRequest defines the request body for encrypting multiple values. properties: plaintexts: description: The values to encrypt. items: items: format: byte type: string type: array type: array x-order: 1 required: - plaintexts type: object StackOverviewResponse: description: StackOverviewResponse contains data to be displayed for the stack overview. properties: referencedStacks: description: The list of stacks referenced by this stack. items: $ref: '#/components/schemas/StackReference' type: array x-order: 2 resources: $ref: '#/components/schemas/GetStackResourcesResponse' description: The resources belonging to this stack. x-order: 3 tags: additionalProperties: type: string description: The tags associated with this stack. type: object x-order: 1 required: - referencedStacks - resources - tags type: object ListMemberStackPermissionsResponse: description: 'ListMemberStackPermissionsResponse describes all the permissions that have been set for a user for a specific stack.' properties: explicitPermission: description: The explicitly assigned permission for this user on this stack enum: - 0 - 101 - 102 - 103 - 104 format: int64 type: integer x-order: 5 x-pulumi-model-property: enumTypeName: StackPermission enumComments: 'StackPermission is a value describing the permission level a user has for a Pulumi stack. Like OrganizationRole, there is a total ordering of StackPermission values, where each value grants an additional layer of permissions. IMPORTANT: Do not rely on the numeric values for auth checks, instead, just refer to these as opaque names. e.g. use explicit matching in a case-statements instead of "if perm >= StackPermissionX". This prevents errors if we later add a new StackPermission "in between" two existing ones, but with a new, higher value. Previously, the StackPermission value was a series of bit flags, with each bit controlling a specific operation on the stack. However, that proved difficult to describe and maintain. So the newer, "fixed set" approach is used instead. The conversion from the legacy permission values and the new StackPermission values is done transparently, whenever data is read/written to the database. (Converting to the newer values as needed.) We will only be able to remove these legacy values after we deploy the code which can read both formats, and only writes the newer format.' enumFieldNames: - None - Read - Write - Admin - Creator enumFieldComments: - StackPermissionNone provides no access. - 'StackPermissionRead provides read-only access, including the ability to decrypt encrypted configuration secrets stored in the service.' - StackPermissionWrite provides read/write access to a stack. - 'StackPermissionAdmin provides admin-level access to the stack. For example, being able to run `pulumi destroy` or delete the stack.' - 'StackPermissionCreator is an implementation quirk of how we mark the user who created a stack. The value is not exported from this module, and is converted to StackPermissionAdmin before being returned to callers. However, in a few places we want to handle the user who created a stack a little differently, and this allows us to do so without exporting a separate "StackPermissionAdminWhoAlsoHappenedToCreateTheStackToo" value.' organizationDefault: description: The organization's default stack permission level enum: - 0 - 101 - 102 - 103 - 104 format: int64 type: integer x-order: 3 x-pulumi-model-property: enumTypeName: StackPermission enumComments: 'StackPermission is a value describing the permission level a user has for a Pulumi stack. Like OrganizationRole, there is a total ordering of StackPermission values, where each value grants an additional layer of permissions. IMPORTANT: Do not rely on the numeric values for auth checks, instead, just refer to these as opaque names. e.g. use explicit matching in a case-statements instead of "if perm >= StackPermissionX". This prevents errors if we later add a new StackPermission "in between" two existing ones, but with a new, higher value. Previously, the StackPermission value was a series of bit flags, with each bit controlling a specific operation on the stack. However, that proved difficult to describe and maintain. So the newer, "fixed set" approach is used instead. The conversion from the legacy permission values and the new StackPermission values is done transparently, whenever data is read/written to the database. (Converting to the newer values as needed.) We will only be able to remove these legacy values after we deploy the code which can read both formats, and only writes the newer format.' enumFieldNames: - None - Read - Write - Admin - Creator enumFieldComments: - StackPermissionNone provides no access. - 'StackPermissionRead provides read-only access, including the ability to decrypt encrypted configuration secrets stored in the service.' - StackPermissionWrite provides read/write access to a stack. - 'StackPermissionAdmin provides admin-level access to the stack. For example, being able to run `pulumi destroy` or delete the stack.' - 'StackPermissionCreator is an implementation quirk of how we mark the user who created a stack. The value is not exported from this module, and is converted to StackPermissionAdmin before being returned to callers. However, in a few places we want to handle the user who created a stack a little differently, and this allows us to do so without exporting a separate "StackPermissionAdminWhoAlsoHappenedToCreateTheStackToo" value.' organizationRole: description: The user's role within the organization enum: - none - member - admin - potential-member - stack-collaborator - billing-manager type: string x-order: 2 x-pulumi-model-property: enumTypeName: OrganizationRole enumComments: OrganizationRole is an enum defining a member's role within an organization. enumFieldNames: - None - Member - Admin - PotentialMember - StackCollaborator - BillingManager enumFieldComments: - OrganizationRoleNone describes the role of non-members. - OrganizationRoleMember is the role for regular members. - OrganizationRoleAdmin is the role for admins. - 'OrganizationRolePotentialMember is the role for users who are explicitly not a member of the organization, but are a member of the backing org on the 3rd party identity provider. (i.e. they could join the org.)' - 'OrganizationRoleStackCollaborator is the role for users who are not a member of an organization, but have been explicitly granted access to some of the organization''s stacks. So they have limited permissions to access the org''s data.' - OrganizationRoleBillingManager is the role for billing admins. teamPermissions: description: The list of team-based permissions for this stack items: $ref: '#/components/schemas/TeamPermission' type: array x-order: 4 userInfo: $ref: '#/components/schemas/UserInfo' description: The user information x-order: 1 required: - explicitPermission - organizationDefault - organizationRole - teamPermissions - userInfo type: object AppUpdateResults: description: 'UpdateResults returns a series of events and the current status of an update. The events can be filtered. See API call for more details.' properties: continuationToken: description: 'ContinuationToken is an opaque value used to indiciate the end of the returned update results. Pass it in the next request to obtain subsequent update events. The same continuation token may be returned if no new update events are available, but the update is still in-progress. A value of nil means that no new updates will be available. Everything has been returned to the client and the update has completed.' type: string x-order: 3 events: description: List of events items: $ref: '#/components/schemas/AppUpdateEvent' type: array x-order: 2 status: description: The current status enum: - not started - requested - running - failed - succeeded - cancelled type: string x-order: 1 x-pulumi-model-property: enumTypeName: AppUpdateStatus enumComments: UpdateStatus is an enum describing the current state during the lifecycle of an update. enumFieldNames: - NotStarted - Requested - Running - Failed - Succeeded - Cancelled enumFieldComments: - StatusNotStarted is returned when the Update has been created but not applied. - StatusRequested is returned when the Update application has been requested but not started. - StatusRunning is returned when the Update is in progress. - StatusFailed is returned when the update has failed. - StatusSucceeded is returned when the update has succeeded. - UpdateStatusCancelled indicates that an update completed due to cancellation. required: - events - status type: object UpdateStackNotificationSettingsRequest: description: UpdateStackNotificationsRequest is the request object to adjust a stack's notification settings. properties: notifyUpdateFailure: description: Whether to send notifications on update failure. type: boolean x-order: 1 notifyUpdateSuccess: description: Whether to send notifications on update success. type: boolean x-order: 2 required: - notifyUpdateFailure - notifyUpdateSuccess type: object AppUntypedDeployment: description: UntypedDeployment contains an inner, untyped deployment structure. properties: deployment: description: The opaque Pulumi deployment payload. Treated as a raw JSON value so the contents are preserved verbatim across client and server versions. type: object x-order: 3 features: description: An optional list of features used by this deployment. The CLI will error when reading a deployment that uses a feature that is not supported by that version of the CLI. Only honored when `version` is 4 or greater. items: type: string type: array x-order: 2 version: description: The schema version of the encoded deployment. format: int64 type: integer x-order: 1 type: object StackMetadata: description: StackMetadata returns metadata about a stack. properties: notificationSettings: $ref: '#/components/schemas/StackNotificationSettings' description: The notification settings for this stack. x-order: 5 orgName: description: The organization that owns the stack. type: string x-order: 1 ownedBy: $ref: '#/components/schemas/UserInfo' description: The user with ownership of this stack x-order: 4 projectName: description: The project that contains the stack. type: string x-order: 2 stackName: description: The stack name within the project. type: string x-order: 3 required: - notificationSettings - orgName - ownedBy - projectName - stackName type: object AppMessage: description: Message is a message from the backend to be displayed to the user. properties: message: description: Message is the message to display to the user. type: string x-order: 2 severity: description: Severity is the severity of the message. enum: - warning - error - info type: string x-order: 1 x-pulumi-model-property: enumTypeName: AppMessageSeverity enumComments: Represents app message severity. required: - message type: object DeploymentJob: description: DeploymentJob represents a deployment job with its status, timing, and step information. properties: lastUpdated: description: The timestamp when the job was last updated. format: date-time type: string x-order: 3 started: description: The timestamp when the job started. format: date-time type: string x-order: 2 status: description: The current status of the deployment job. enum: - not-started - accepted - running - failed - succeeded - skipped type: string x-order: 1 x-pulumi-model-property: enumTypeName: JobStatus enumComments: JobStatus describes the status of a job run. enumFieldNames: - NotStarted - Accepted - Running - Failed - Succeeded - Skipped enumFieldComments: - JobStatusNotStarted indicates that a job has not yet started. - JobStatusAccepted indicates that a job has been accepted for execution, but is not yet running. - JobStatusRunning indicates that a job is running. - JobStatusFailed indicates that a job has failed. - JobStatusSucceeded indicates that a job has succeeded. - JobStatusSkipped indicates that a job has skipped as there are fresher deployments to execute in the queue. steps: description: The list of steps in the deployment job. items: $ref: '#/components/schemas/StepRun' type: array x-order: 4 required: - status - steps type: object AppResOpFailedEvent: description: 'ResOpFailedEvent is emitted when a resource operation fails. Typically a DiagnosticEvent is emitted before this event, indicating the root cause of the error.' properties: metadata: $ref: '#/components/schemas/AppStepEventMetadata' description: The metadata x-order: 1 status: description: The current status format: int64 type: integer x-order: 2 steps: description: The steps format: int64 type: integer x-order: 3 required: - metadata - status - steps type: object AppPatchUpdateVerbatimCheckpointRequest: description: 'PatchUpdateVerbatimCheckpointRequest defines the body of a request to a patch update checkpoint endpoint of the service API, where `UntypedDeloyment` is an `apitype.UntypedDeployment`. Whereas the PatchUpdateCheckpointRequest API is subject to the service reformatting how a checkpoint is persisted, PatchUpdateVerbatimCheckpointRequest enables the CLI to define the exact format. Designed to be compatible with the PatchUpdateCheckpointDeltaRequest API, where formatting is critical in calculating textual diffs.' properties: sequenceNumber: description: Idempotency key incremented by the client on every PATCH call within the same update. format: int64 type: integer x-order: 3 untypedDeployment: description: The untyped deployment type: object x-order: 2 version: description: The version number format: int64 type: integer x-order: 1 required: - sequenceNumber - version type: object AppResourceV3: description: 'ResourceV3 is the third version of the Resource API type. It absorbs a few breaking changes: 1. It adds a map from input property names to the dependencies that affect that input property. This is used to improve the precision of delete-before-create operations. 2. It adds a new boolean field, `PendingReplacement`, that marks resources that have been deleted as part of a delete-before-create operation but have not yet been recreated. Migrating from ResourceV2 to ResourceV3 involves: 1. Populating the map from input property names to dependencies by assuming that every dependency listed in `Dependencies` affects every input property.' properties: additionalSecretOutputs: description: AdditionalSecretOutputs is a list of outputs that were explicitly marked as secret when the resource was created. items: type: string type: array x-order: 17 aliases: description: Aliases is a list of previous URNs that this resource may have had in previous deployments. items: type: string type: array x-order: 18 created: description: Created tracks when the remote resource was first added to state by pulumi. Checkpoints prior to early 2023 do not include this. format: date-time type: string x-order: 24 custom: description: Custom is true when it is managed by a plugin. type: boolean x-order: 2 customTimeouts: $ref: '#/components/schemas/AppResCustomTimeouts' description: CustomTimeouts is a configuration block that can be used to control timeouts of CRUD operations. x-order: 19 delete: description: Delete is true when the resource should be deleted during the next update. type: boolean x-order: 3 deletedWith: description: 'If set, the providers Delete method will not be called for this resource if specified resource is being deleted as well.' type: string x-order: 22 dependencies: description: Dependencies contains the dependency edges to other resources that this depends on. items: type: string type: array x-order: 12 external: description: External is set to true when the lifecycle of this resource is not managed by Pulumi. type: boolean x-order: 11 hideDiff: description: HideDiff is a list of properties to hide the diff for. items: type: string type: array x-order: 29 id: description: ID is the provider-assigned resource, if any, for custom resources. type: string x-order: 4 ignoreChanges: description: IgnoreChanges is a list of properties to ignore changes for. items: type: string type: array x-order: 28 importID: description: ImportID is the import input used for imported resources. type: string x-order: 20 initErrors: description: 'InitErrors is the set of errors encountered in the process of initializing resource (i.e., during create or update).' items: type: string type: array x-order: 13 inputs: additionalProperties: type: object description: Inputs are the input properties supplied to the provider. type: object x-order: 6 modified: description: Modified tracks when the resource state was last altered. Checkpoints prior to early 2023 do not include this. format: date-time type: string x-order: 25 outputs: additionalProperties: type: object description: Outputs are the output properties returned by the provider after provisioning. type: object x-order: 7 parent: description: Parent is an optional parent URN if this resource is a child of it. type: string x-order: 8 pendingReplacement: description: 'PendingReplacement is used to track delete-before-replace resources that have been deleted but not yet recreated.' type: boolean x-order: 16 propertyDependencies: additionalProperties: items: type: string type: array description: PropertyDependencies maps from an input property name to the set of resources that property depends on. type: object x-order: 15 protect: description: Protect is set to true when this resource is "protected" and may not be deleted. type: boolean x-order: 9 provider: description: Provider is a reference to the provider that is associated with this resource. type: string x-order: 14 refreshBeforeUpdate: description: RefreshBeforeUpdate indicates that this resource should always be refreshed prior to updates. type: boolean x-order: 32 replaceOnChanges: description: ReplaceOnChanges is a list of properties that if changed trigger a replace. items: type: string type: array x-order: 30 replaceWith: description: ReplaceWith is a list of resources whose replaces will also trigger this resource's replace. items: type: string type: array x-order: 23 replacementTrigger: description: If set, the engine will diff this with the last recorded value, and trigger a replace if they are not equal. type: object x-order: 31 resourceHooks: additionalProperties: items: type: string type: array description: ResourceHooks is a map of hook types to lists of hook names for the given type. type: object x-order: 34 retainOnDelete: description: If set to True, the providers Delete method will not be called for this resource. Pulumi simply stops tracking the deleted resource. type: boolean x-order: 21 sourcePosition: description: SourcePosition tracks the source location of this resource's registration type: string x-order: 26 stackTrace: description: StackTrace records the stack at the time this resource was registered items: $ref: '#/components/schemas/AppStackFrameV1' type: array x-order: 27 taint: description: Taint is set to true when we wish to force it to be replaced upon the next update. type: boolean x-order: 10 type: description: Type is the resource's full type token. type: string x-order: 5 urn: description: URN uniquely identifying this resource. type: string x-order: 1 viewOf: description: ViewOf is a reference to the resource that this resource is a view of. type: string x-order: 33 required: - custom - type - urn type: object StackNotificationSettings: description: StackNotificationSettings is the object containing the notification settings for a stack. properties: notifyUpdateFailure: description: Whether to send a notification when a stack update fails. type: boolean x-order: 1 notifyUpdateSuccess: description: Whether to send a notification when a stack update succeeds. type: boolean x-order: 2 required: - notifyUpdateFailure - notifyUpdateSuccess type: object TeamStackPermission: description: TeamStackPermission is the permission team membership grants to a stack. properties: permission: description: The permission level the team has on this stack (e.g., read, write, admin). enum: - 0 - 101 - 102 - 103 - 104 format: int64 type: integer x-order: 3 x-pulumi-model-property: enumTypeName: StackPermission enumComments: 'StackPermission is a value describing the permission level a user has for a Pulumi stack. Like OrganizationRole, there is a total ordering of StackPermission values, where each value grants an additional layer of permissions. IMPORTANT: Do not rely on the numeric values for auth checks, instead, just refer to these as opaque names. e.g. use explicit matching in a case-statements instead of "if perm >= StackPermissionX". This prevents errors if we later add a new StackPermission "in between" two existing ones, but with a new, higher value. Previously, the StackPermission value was a series of bit flags, with each bit controlling a specific operation on the stack. However, that proved difficult to describe and maintain. So the newer, "fixed set" approach is used instead. The conversion from the legacy permission values and the new StackPermission values is done transparently, whenever data is read/written to the database. (Converting to the newer values as needed.) We will only be able to remove these legacy values after we deploy the code which can read both formats, and only writes the newer format.' enumFieldNames: - None - Read - Write - Admin - Creator enumFieldComments: - StackPermissionNone provides no access. - 'StackPermissionRead provides read-only access, including the ability to decrypt encrypted configuration secrets stored in the service.' - StackPermissionWrite provides read/write access to a stack. - 'StackPermissionAdmin provides admin-level access to the stack. For example, being able to run `pulumi destroy` or delete the stack.' - 'StackPermissionCreator is an implementation quirk of how we mark the user who created a stack. The value is not exported from this module, and is converted to StackPermissionAdmin before being returned to callers. However, in a few places we want to handle the user who created a stack a little differently, and this allows us to do so without exporting a separate "StackPermissionAdminWhoAlsoHappenedToCreateTheStackToo" value.' permissionSetName: description: Display name of the permission set for this stack, when available. Enables read-only entity access UI without requiring RoleRead. type: string x-order: 4 projectName: description: The project containing the stack. type: string x-order: 1 stackName: description: The stack within the project. type: string x-order: 2 required: - permission - projectName - stackName type: object AppBatchEncryptResponse: description: BatchEncryptResponse defines the response body for multiple encrypted values. properties: ciphertexts: description: The encrypted values, in order of the plaintexts from the request. items: items: format: byte type: string type: array type: array x-order: 1 required: - ciphertexts type: object TeamMemberInfo: allOf: - $ref: '#/components/schemas/UserInfo' - description: TeamMemberInfo is a UserInfo extended to contain the TeamRole. properties: role: description: The member's role within the team. enum: - none - member - admin type: string x-order: 1 x-pulumi-model-property: enumTypeName: TeamRole enumComments: TeamRole is the kind of role a user has in a team. required: - role type: object UserPermission: description: UserPermission describes a user's permission level for a stack. properties: permission: description: The permission level the user has on the stack (e.g., read, write, admin). enum: - 0 - 101 - 102 - 103 - 104 format: int64 type: integer x-order: 2 x-pulumi-model-property: enumTypeName: StackPermission enumComments: 'StackPermission is a value describing the permission level a user has for a Pulumi stack. Like OrganizationRole, there is a total ordering of StackPermission values, where each value grants an additional layer of permissions. IMPORTANT: Do not rely on the numeric values for auth checks, instead, just refer to these as opaque names. e.g. use explicit matching in a case-statements instead of "if perm >= StackPermissionX". This prevents errors if we later add a new StackPermission "in between" two existing ones, but with a new, higher value. Previously, the StackPermission value was a series of bit flags, with each bit controlling a specific operation on the stack. However, that proved difficult to describe and maintain. So the newer, "fixed set" approach is used instead. The conversion from the legacy permission values and the new StackPermission values is done transparently, whenever data is read/written to the database. (Converting to the newer values as needed.) We will only be able to remove these legacy values after we deploy the code which can read both formats, and only writes the newer format.' enumFieldNames: - None - Read - Write - Admin - Creator enumFieldComments: - StackPermissionNone provides no access. - 'StackPermissionRead provides read-only access, including the ability to decrypt encrypted configuration secrets stored in the service.' - StackPermissionWrite provides read/write access to a stack. - 'StackPermissionAdmin provides admin-level access to the stack. For example, being able to run `pulumi destroy` or delete the stack.' - 'StackPermissionCreator is an implementation quirk of how we mark the user who created a stack. The value is not exported from this module, and is converted to StackPermissionAdmin before being returned to callers. However, in a few places we want to handle the user who created a stack a little differently, and this allows us to do so without exporting a separate "StackPermissionAdminWhoAlsoHappenedToCreateTheStackToo" value.' user: $ref: '#/components/schemas/UserInfo' description: The user who has been granted access to the stack. x-order: 1 required: - permission - user type: object AppPolicyPackMetadata: description: PolicyPackMetadata is the metadata of a Policy Pack. properties: config: additionalProperties: type: object description: 'The configuration that is to be passed to the Policy Pack. This map ties Policies with their configuration.' type: object x-order: 5 displayName: description: The display name type: string x-order: 2 environments: description: References to ESC environments to use for this policy pack. items: type: string type: array x-order: 6 name: description: The name type: string x-order: 1 version: description: The version number format: int64 type: integer x-order: 3 versionTag: description: The version tag type: string x-order: 4 required: - displayName - name - version - versionTag type: object AppOperationV2: description: 'OperationV2 represents an operation that the engine is performing. It consists of a Resource, which is the state that the engine used to initiate the operation, and a Status, which is a string representation of the operation that the engine initiated.' properties: resource: $ref: '#/components/schemas/AppResourceV3' description: Resource is the state that the engine used to initiate this operation. x-order: 1 type: description: Status is a string representation of the operation that the engine is performing. enum: - creating - updating - deleting - reading type: string x-order: 2 x-pulumi-model-property: enumTypeName: AppOperationType enumComments: 'OperationType is the type of an operation initiated by the engine. Its value indicates the type of operation that the engine initiated.' enumFieldComments: - OperationTypeCreating is the state of resources that are being created. - OperationTypeUpdating is the state of resources that are being updated. - OperationTypeDeleting is the state of resources that are being deleted. - OperationTypeReading is the state of resources that are being read. required: - resource - type type: object AppSecretsProvidersV1: description: Represents app secrets providers v1. properties: state: description: The current state type: object x-order: 2 type: description: The type type: string x-order: 1 required: - type type: object Activity: description: Represents activity. properties: deployment: $ref: '#/components/schemas/DeploymentWithRelatedUpdates' description: The deployment data x-order: 2 update: $ref: '#/components/schemas/UpdateInfo' description: The update x-order: 1 type: object GitHubPullRequest: description: GitHubPullRequest describes a GitHub pull request that a stack update was associated with. properties: closedAt: description: Unix epoch timestamp (seconds) of when the PR was closed. Null if the PR is still open. format: int64 type: integer x-order: 5 createdAt: description: Unix epoch timestamp (seconds) of when the PR was created. format: int64 type: integer x-order: 4 mergeCommitSHA: description: The SHA of the merge commit, if the PR was merged type: string x-order: 9 number: description: The pull request number format: int64 type: integer x-order: 2 repoSlug: description: The repository slug in owner/repo format type: string x-order: 3 sourceRef: description: The source branch reference type: string x-order: 7 targetRef: description: The target branch reference type: string x-order: 8 title: description: The title of the pull request type: string x-order: 1 wasMerged: description: Whether the PR was merged type: boolean x-order: 6 required: - createdAt - number - repoSlug - sourceRef - targetRef - title - wasMerged type: object AppProgressEvent: description: ProgressEvent is emitted when a potentially long-running engine process is in progress. properties: done: description: True if and only if the process has completed. type: boolean x-order: 6 id: description: A unique identifier for the process. type: string x-order: 2 message: description: A message accompanying the process. type: string x-order: 3 received: description: The number of items completed so far (e.g. bytes received, items installed, etc.) format: int64 type: integer x-order: 4 total: description: The total number of items that must be completed. format: int64 type: integer x-order: 5 type: description: The type of process (e.g. plugin download, plugin install). enum: - plugin-download - plugin-install type: string x-order: 1 x-pulumi-model-property: enumTypeName: AppProgressType enumComments: ProgressType is the type of process occurring. enumFieldNames: - PluginDownload - PluginInstall enumFieldComments: - PluginDownload represents a download of a plugin. - PluginInstall represents the installation of a plugin. required: - done - id - message - received - total - type type: object AppImportStackResponse: description: ImportStackResponse defines the response body for importing a Stack. properties: updateId: description: The update identifier type: string x-order: 1 required: - updateId type: object AppUpdateProgramResponse: description: UpdateProgramResponse is the result of an update program request. properties: aiSettings: $ref: '#/components/schemas/AppAISettingsForUpdate' description: The ai settings x-order: 4 messages: description: Messages is a list of messages that should be displayed to the user. items: $ref: '#/components/schemas/AppMessage' type: array x-order: 3 requiredPolicies: description: RequiredPolicies is a list of required Policy Packs to run during the update. items: $ref: '#/components/schemas/AppRequiredPolicy' type: array x-order: 2 updateID: description: 'UpdateID is the opaque identifier of the requested update. This value is needed to begin an update, as well as poll for its progress.' type: string x-order: 1 required: - updateID type: object StepRun: description: StepRun contains information about a step run. properties: lastUpdated: description: The timestamp when the step was last updated. format: date-time type: string x-order: 4 name: description: The name of the step. type: string x-order: 1 started: description: The timestamp when the step started. format: date-time type: string x-order: 3 status: description: The current status of the step. enum: - not-started - running - failed - succeeded type: string x-order: 2 x-pulumi-model-property: enumTypeName: StepStatus enumComments: StepStatus describes the status of a step in a workflow job run. enumFieldNames: - NotStarted - Running - Failed - Succeeded enumFieldComments: - StepStatusNotStarted indicates that a step has not yet started. - StepStatusRunning indicates that a step is running. - StepStatusFailed indicates that a step has failed. - StepStatusSucceeded indicates that a step has succeeded. required: - name - status type: object AppPolicyAnalyzeStackSummaryEvent: description: PolicyAnalyzeStackSummaryEvent is emitted after a call to AnalyzeStack on an analyzer, summarizing the results. properties: failed: description: The names of stack policies that failed (i.e. produced violations). items: type: string type: array x-order: 5 passed: description: The names of stack policies that passed (i.e. did not produce any violations). items: type: string type: array x-order: 4 policyPackName: description: The name of the policy pack. type: string x-order: 1 policyPackVersion: description: The version of the policy pack. type: string x-order: 2 policyPackVersionTag: description: The version tag of the policy pack. type: string x-order: 3 required: - policyPackName - policyPackVersion - policyPackVersionTag type: object AppRequiredPolicy: description: RequiredPolicy is the information regarding a particular Policy that is required by an organization. properties: config: additionalProperties: type: object description: 'The configuration that is to be passed to the Policy Pack. This is map a of policies mapped to their configuration. Each individual configuration must comply with the JSON schema for each Policy within the Policy Pack.' type: object x-order: 6 displayName: description: The pretty name of the required Policy Pack. type: string x-order: 4 environments: description: References to ESC environments whose resolved values the CLI should inject into the policy pack process. items: type: string type: array x-order: 7 name: description: The name (unique and URL-safe) of the required Policy Pack. type: string x-order: 1 packLocation: description: Where the Policy Pack can be downloaded from. type: string x-order: 5 version: description: The version of the required Policy Pack. format: int64 type: integer x-order: 2 versionTag: description: The version tag of the required Policy Pack. type: string x-order: 3 required: - displayName - name - version - versionTag type: object ResourceInfo: description: ResourceInfo wraps a basic resource and provides contextual information. properties: resource: $ref: '#/components/schemas/Resource' description: The underlying resource with its properties, URN, type, and provider state. x-order: 1 required: - resource type: object Webhook: description: 'Webhook describes a webhook registered with the Pulumi Service. It may be registered to either an Organization, Stack or Environment.' properties: active: description: Whether the webhook is active and will receive deliveries. type: boolean x-order: 9 displayName: description: The human-readable display name shown in the UI. type: string x-order: 6 envName: description: The environment name. Set when the webhook is scoped to a specific environment. type: string x-order: 4 filters: description: Specific event types this webhook subscribes to. If empty, all events are delivered. items: type: string type: array x-order: 11 format: description: The format of the webhook payload (e.g., 'raw', 'slack', 'ms_teams'). type: string x-order: 10 groups: description: Event groups this webhook subscribes to (e.g., 'stacks', 'deployments'). items: type: string type: array x-order: 12 name: description: The unique identifier name for the webhook within its scope. type: string x-order: 5 organizationName: description: The organization that owns this webhook. type: string x-order: 1 payloadUrl: description: The URL to which webhook payloads are delivered. type: string x-order: 7 projectName: description: The project name. Set when the webhook is scoped to a specific stack. type: string x-order: 2 secret: description: Secret will be omitted when returned from the service. type: string x-order: 8 stackName: description: The stack name. Set when the webhook is scoped to a specific stack. type: string x-order: 3 required: - active - displayName - name - organizationName - payloadUrl type: object AppGetStackPolicyPacksResponse: description: 'GetStackPolicyPacksResponse is the response to getting the applicable Policy Packs for a particular stack. This allows the CLI to download the packs prior to starting an update.' properties: requiredPolicies: description: RequiredPolicies is a list of required Policy Packs to run during the update. items: $ref: '#/components/schemas/AppRequiredPolicy' type: array x-order: 1 type: object AppJournalEntries: description: Collection of app journal entries. properties: entries: description: List of entries items: $ref: '#/components/schemas/AppJournalEntry' type: array x-order: 1 type: object ConsoleUpdateSummary: description: A human readable summary of the update, in the same manner as generated by the CLI via commands such as `pulumi up`. properties: summary: description: Human-readable text summarizing the update results (resource counts, changes, etc.). type: string x-order: 1 required: - summary type: object AppPropertyDiff: description: PropertyDiff describes the difference between a single property's old and new values. properties: diffKind: description: Kind is the kind of difference. enum: - add - add-replace - delete - delete-replace - update - update-replace type: string x-order: 1 x-pulumi-model-property: enumTypeName: AppDiffKind enumComments: DiffKind describes the kind of a particular property diff. enumFieldNames: - DiffAdd - DiffAddReplace - DiffDelete - DiffDeleteReplace - DiffUpdate - DiffUpdateReplace enumFieldComments: - DiffAdd indicates that the property was added. - DiffAddReplace indicates that the property was added and requires that the resource be replaced. - DiffDelete indicates that the property was deleted. - DiffDeleteReplace indicates that the property was deleted and requires that the resource be replaced. - DiffUpdate indicates that the property was updated. - DiffUpdateReplace indicates that the property was updated and requires that the resource be replaced. inputDiff: description: InputDiff is true if this is a difference between old and new inputs rather than old state and new inputs. type: boolean x-order: 2 required: - diffKind - inputDiff type: object ListStackCollaboratorsResponse: description: ListStackCollaboratorsResponse is the response when querying a stack's collaborators. properties: stackCreatorUserName: description: 'StackCreatorUserName is the user name of the stack creator. If stack creator''s permissions have been removed then this will be null and will be omitted from the json response.' type: string x-order: 2 users: description: 'Other users explicitly added as collaborators on this stack. (Those inheriting permissions from the org aren''t included.)' items: $ref: '#/components/schemas/UserPermission' type: array x-order: 1 required: - users type: object AppDiagnosticEvent: description: 'DiagnosticEvent is emitted whenever a diagnostic message is provided, for example errors from a cloud resource provider while trying to create or update a resource.' properties: color: description: The output color type: string x-order: 4 ephemeral: description: Whether ephemeral is enabled type: boolean x-order: 7 message: description: The message content type: string x-order: 3 prefix: description: The prefix type: string x-order: 2 severity: description: Severity is one of "info", "info#err", "warning", or "error". type: string x-order: 5 streamID: description: The stream identifier format: int64 type: integer x-order: 6 urn: description: The Pulumi URN type: string x-order: 1 required: - color - message - severity type: object AppRenewUpdateLeaseRequest: description: RenewUpdateLeaseRequest defines the body of a request to the update lease renewal endpoint of the service API. properties: duration: description: The duration for which to renew the lease in seconds (maximum 300). format: int64 type: integer x-order: 2 token: description: 'The current, valid lease token. DEPRECATED as of Pulumi API version 5+. Pulumi API will expect the update token in the Authorization header instead of this property. This property will be removed when the minimum supported API version on the service is raised to 5.' type: string x-order: 1 required: - duration - token type: object AppSnapshotMetadataV1: description: SnapshotMetadataV1 contains metadata about a deployment snapshot. properties: integrity_error: $ref: '#/components/schemas/AppSnapshotIntegrityErrorMetadataV1' description: Metadata associated with any integrity error affecting the snapshot. x-order: 1 type: object GetStackResourcesResponse: description: GetStackResourcesResponse returns the resources for a stack at a particular update. properties: region: description: The cloud region where the resources are deployed type: string x-order: 2 resources: description: The list of resources in the stack items: $ref: '#/components/schemas/ResourceInfo' type: array x-order: 1 version: description: The update version number format: int64 type: integer x-order: 3 required: - region - resources - version type: object AppEngineEventBatch: description: EngineEventBatch is a group of engine events. properties: events: description: List of events items: $ref: '#/components/schemas/AppEngineEvent' type: array x-order: 1 required: - events type: object AppSummaryEvent: description: SummaryEvent is emitted at the end of an update, with a summary of the changes made. properties: PolicyPacks: additionalProperties: type: string description: Policy Packs run during the update, as a map from policy pack name to version. For newer clients, the value is the version tag prefixed with `v`; for older clients it is the raw version. type: object x-order: 4 durationSeconds: description: Duration is the number of seconds the update was executing. format: int64 type: integer x-order: 2 isPreview: description: IsPreview indicates whether this is a preview or an update. type: boolean x-order: 5 maybeCorrupt: description: MaybeCorrupt is set if one or more of the resources is in an invalid state. type: boolean x-order: 1 resourceChanges: additionalProperties: format: int64 type: integer description: ResourceChanges contains the count for resource change by type. type: object x-order: 3 required: - PolicyPacks - durationSeconds - isPreview - maybeCorrupt - resourceChanges type: object AppUpdateEvent: description: UpdateEvent describes an event that happened on the Pulumi Cloud while processing an update. properties: fields: additionalProperties: type: object description: The fields type: object x-order: 3 index: description: The index type: string x-order: 1 kind: description: The kind enum: - stdout - stderr type: string x-order: 2 x-pulumi-model-property: enumTypeName: AppUpdateEventKind enumComments: UpdateEventKind is an enum for the type of update events. enumFieldNames: - StdoutEvent - StderrEvent enumFieldComments: - StdoutEvent is used to mark the event being emitted to STDOUT. - StderrEvent is used to mark the event being emitted to STDERR. required: - fields - index - kind type: object GitHubCommitInfo: description: 'GitHubCommitInfo contains summary information about a GitHub commit. We try to provide as much information as possible, so in some situations only a subset of the fields are present. https://developer.github.com/v3/git/commits/#get-a-commit' properties: author: $ref: '#/components/schemas/UserInfo' description: The author of the commit x-order: 5 committer: $ref: '#/components/schemas/UserInfo' description: The committer of the commit x-order: 6 message: description: The commit message type: string x-order: 4 sha: description: The commit SHA hash type: string x-order: 2 slug: description: / type: string x-order: 1 url: description: The URL to the commit on GitHub type: string x-order: 3 type: object StackReference: description: StackReference contains information about a stack reference. properties: name: description: The name of the referenced stack. type: string x-order: 3 organization: description: The organization that owns the referenced stack. type: string x-order: 1 routingProject: description: The project used for routing to the referenced stack. type: string x-order: 2 version: description: The version of the stack when it was referenced. format: int64 type: integer x-order: 4 required: - name - organization - routingProject - version type: object AppPolicyRemediationEvent: description: PolicyRemediationEvent is emitted whenever there is Policy transformation. properties: after: additionalProperties: type: object description: Map of after type: object x-order: 8 before: additionalProperties: type: object description: Map of before type: object x-order: 7 color: description: The output color type: string x-order: 2 policyName: description: The policy name type: string x-order: 3 policyPackName: description: The policy pack name type: string x-order: 4 policyPackVersion: description: The policy pack version type: string x-order: 5 policyPackVersionTag: description: The policy pack version tag type: string x-order: 6 resourceUrn: description: The resource urn type: string x-order: 1 required: - color - policyName - policyPackName - policyPackVersion - policyPackVersionTag type: object AppSnapshotIntegrityErrorMetadataV1: description: 'SnapshotIntegrityErrorMetadataV1 contains metadata about a snapshot integrity error, such as the version and invocation of the Pulumi engine that caused it.' properties: command: description: The command/invocation of the Pulumi engine that caused the integrity error. type: string x-order: 2 env_vars: additionalProperties: type: string description: The Pulumi environment variables that were set when the integrity error occurred. type: object x-order: 4 error: description: The error message associated with the integrity error. type: string x-order: 3 version: description: The version of the Pulumi engine that caused the integrity error. type: string x-order: 1 type: object AppLog3rdPartyDecryptionEvent: description: Log3rdPartyDecryptionEvent defines the request body for logging a 3rd party secrets provider decryption event. properties: commandName: description: The command name type: string x-order: 2 secretName: description: The secret name type: string x-order: 1 type: object AppStartUpdateRequest: description: StartUpdateRequest requests that an update starts getting applied to a stack. properties: journalVersion: description: 'JournalVersion indicates the maximum journal version the client supports. If 0, journaling is not supported.' format: int64 type: integer x-order: 2 tags: additionalProperties: type: string description: 'Tags contains an updated set of Tags for the stack. If non-nil, will replace the current set of tags associated with the stack.' type: object x-order: 1 type: object Resource: description: 'Resource is the shape of a Pulumi-managed resource as exposed from the Pulumi Service. This type wraps pulumi/pulumi''s pkg/apitype ResourceV1 and ResourceV2 types, which are sent from the CLI to the Service as part of performing updates. Those types wrap pulumi/pulumi''s pkg/resource State type, which is the engine-internal representation.' properties: additionalSecretOutputs: description: AdditionalSecretOutputs is a list of outputs that were explicitly marked as secret when the resource was created. items: type: string type: array x-order: 11 aliases: description: Aliases is a list of previous URNs that this resource may have had in previous deployments. items: type: string type: array x-order: 12 custom: description: Custom is true when the resource is managed by a plugin. type: boolean x-order: 4 delete: description: Delete is true when the resource should be deleted during the next update. type: boolean x-order: 5 deletedWith: description: 'If set, the providers Delete method will not be called for this resource if specified resource is being deleted as well.' type: string x-order: 13 dependencies: description: Dependencies contains the URN dependency edges to other resources that this depends on. items: type: string type: array x-order: 6 external: description: External is set to true when the lifecycle of this resource is not managed by Pulumi. type: boolean x-order: 9 id: description: ID is the provider-assigned resource ID, if any, for custom resources. type: string x-order: 1 initErrors: description: 'InitErrors is the set of errors encountered in the process of initializing resource (i.e., during create or update).' items: type: string type: array x-order: 14 inputs: additionalProperties: type: object description: Inputs are the input properties supplied to the provider. type: object x-order: 15 outputs: additionalProperties: type: object description: Outputs are the output properties returned by the provider after provisioning. type: object x-order: 16 parent: description: Parent is an optional parent URN if this resource is a child of it. type: string x-order: 7 protect: description: Protect is set to true when this resource is "protected" and may not be deleted. type: boolean x-order: 8 providerInputs: additionalProperties: type: object description: 'The inputs to the provider which created this resource. This can be used when generating console links (e.g. the value of aws:region will be in this property bag with the key "region" and the value of whatever region was set on the provider that created this resource).' type: object x-order: 17 retainOnDelete: description: 'If set to True, the providers Delete method will not be called for this resource. Pulumi simply stops tracking the deleted resource.' type: boolean x-order: 10 type: description: Type is the resource's full type token. type: string x-order: 2 urn: description: URN uniquely identifying this resource within a stack. (But not globally across all stacks.) type: string x-order: 3 required: - custom - delete - dependencies - type - urn type: object AppEncryptValueRequest: description: EncryptValueRequest defines the request body for encrypting a value. properties: plaintext: description: The value to encrypt. items: format: byte type: string type: array x-order: 1 required: - plaintext type: object AppEngineEvent: description: 'EngineEvent describes a Pulumi engine event, such as a change to a resource or diagnostic message. EngineEvent is a discriminated union of all possible event types, and exactly one field will be non-nil.' properties: cancelEvent: $ref: '#/components/schemas/AppCancelEvent' description: The cancel event x-order: 3 diagnosticEvent: $ref: '#/components/schemas/AppDiagnosticEvent' description: The diagnostic event x-order: 5 errorEvent: $ref: '#/components/schemas/AppErrorEvent' description: The error event x-order: 19 policyAnalyzeStackSummaryEvent: $ref: '#/components/schemas/AppPolicyAnalyzeStackSummaryEvent' description: The policy analyze stack summary event x-order: 16 policyAnalyzeSummaryEvent: $ref: '#/components/schemas/AppPolicyAnalyzeSummaryEvent' description: The policy analyze summary event x-order: 14 policyEvent: $ref: '#/components/schemas/AppPolicyEvent' description: The policy event x-order: 11 policyLoadEvent: $ref: '#/components/schemas/AppPolicyLoadEvent' description: The policy load event x-order: 13 policyRemediateSummaryEvent: $ref: '#/components/schemas/AppPolicyRemediateSummaryEvent' description: The policy remediate summary event x-order: 15 policyRemediationEvent: $ref: '#/components/schemas/AppPolicyRemediationEvent' description: The policy remediation event x-order: 12 preludeEvent: $ref: '#/components/schemas/AppPreludeEvent' description: The prelude event x-order: 6 progressEvent: $ref: '#/components/schemas/AppProgressEvent' description: The progress event x-order: 18 resOpFailedEvent: $ref: '#/components/schemas/AppResOpFailedEvent' description: The res op failed event x-order: 10 resOutputsEvent: $ref: '#/components/schemas/AppResOutputsEvent' description: The res outputs event x-order: 9 resourcePreEvent: $ref: '#/components/schemas/AppResourcePreEvent' description: The resource pre event x-order: 8 sequence: description: "Sequence is a unique, and monotonically increasing number for each engine event sent to the\nPulumi Service. Since events may be sent concurrently, and/or delayed via network routing,\nthe sequence number is to ensure events can be placed into a total ordering.\n\n- No two events can have the same sequence number.\n- Events with a lower sequence number must have been emitted before those with a higher\n sequence number." format: int64 type: integer x-order: 1 startDebuggingEvent: $ref: '#/components/schemas/AppStartDebuggingEvent' description: The start debugging event x-order: 17 stdoutEvent: $ref: '#/components/schemas/AppStdoutEngineEvent' description: The stdout event x-order: 4 summaryEvent: $ref: '#/components/schemas/AppSummaryEvent' description: The summary event x-order: 7 timestamp: description: Timestamp is a Unix timestamp (seconds) of when the event was emitted. format: int64 type: integer x-order: 2 required: - sequence - timestamp type: object AppStack: description: Stack describes a Stack running on a Pulumi Cloud. properties: activeUpdate: description: The active update type: string x-order: 6 config: $ref: '#/components/schemas/AppStackConfig' description: 'Optional cloud-persisted stack configuration. If set, then the stack''s configuration is loaded from the cloud and not a file on disk.' x-order: 8 currentOperation: $ref: '#/components/schemas/AppOperationStatus' description: CurrentOperation provides information about a stack operation in-progress, as applicable. x-order: 5 id: description: The logical identifier of the stack. type: string x-order: 1 orgName: description: The organization name type: string x-order: 2 projectName: description: The project name type: string x-order: 3 stackName: description: The stack name type: string x-order: 4 tags: additionalProperties: type: string description: Map of tags type: object x-order: 7 version: description: The version number format: int64 type: integer x-order: 9 required: - activeUpdate - id - orgName - projectName - stackName - version type: object AppOperationStatus: description: OperationStatus describes the state of an operation being performed on a Pulumi stack. properties: author: description: The login of the user who initiated this operation. type: string x-order: 2 kind: description: The type of operation in progress (e.g. 'update', 'preview', 'destroy', 'refresh'). enum: - update - preview - refresh - rename - destroy - import - Pupdate - Prefresh - Pdestroy - Pimport - Prename type: string x-order: 1 x-pulumi-model-property: enumTypeName: AppUpdateKind enumComments: 'UpdateKind is an enum for the type of update performed. Should generally mirror backend.UpdateKind, but we clone it in this package to add flexibility in case there is a breaking change in the backend-type.' enumFieldNames: - Update - Preview - Refresh - Rename - Destroy - Import - PreviewUpdate - PreviewRefresh - PreviewDestroy - PreviewImport - PreviewRename enumFieldComments: - A Pulumi program update. - A preview of an update, without impacting resources. - A refresh operation. - 'A rename of the stack or project name. NOTE: Do not remove this type - it is used by Pulumi Cloud code.' - An update which removes all resources. - An update that entails importing a raw checkpoint file. - A preview of an update operation. - A preview of a refresh operation. - A preview of a destroy operation. - A preview of an import operation. - A preview of a rename operation. started: description: Unix epoch timestamp (seconds) when the operation started. format: int64 type: integer x-order: 3 required: - author - kind - started type: object AppPluginInfoV1: description: PluginInfoV1 captures the version and information about a plugin. properties: name: description: The name type: string x-order: 1 path: description: The path type: string x-order: 2 type: description: The type enum: - analyzer - language - resource - converter - tool type: string x-order: 3 x-pulumi-model-property: enumTypeName: AppPluginKind enumComments: 'apitype.PluginKind represents a kind of a plugin that may be dynamically loaded and used by Pulumi. These are being re exported in sdk/go/common/workspace/plugins.go to keep backward compatibility and should be kept in sync' enumFieldNames: - AnalyzerPlugin - LanguagePlugin - ResourcePlugin - ConverterPlugin - ToolPlugin enumFieldComments: - AnalyzerPlugin is a plugin that can be used as a resource analyzer. - LanguagePlugin is a plugin that can be used as a language host. - ResourcePlugin is a plugin that can be used as a resource provider for custom CRUD operations. - ConverterPlugin is a plugin that can be used to convert from other ecosystems to Pulumi. - ToolPlugin is an arbitrary plugin that can be run as a tool. version: description: The version number type: string x-order: 4 required: - name - path - type - version type: object WebhookDelivery: description: 'WebhookDelivery is a result of a webhook that was sent. i.e. the Pulumi-side logs for the end-users webhook. It merges both model.WebhookEvent and model.WebhookDelivery.' properties: duration: description: The duration of the delivery request in milliseconds. format: int64 type: integer x-order: 5 id: description: The unique identifier of the delivery. type: string x-order: 1 kind: description: The kind of webhook event. type: string x-order: 2 payload: description: The JSON payload that was sent. type: string x-order: 3 requestHeaders: description: The HTTP headers sent with the request. type: string x-order: 7 requestUrl: description: The URL the webhook was delivered to. type: string x-order: 6 responseBody: description: The HTTP response body. type: string x-order: 10 responseCode: description: The HTTP response status code. format: int64 type: integer x-order: 8 responseHeaders: description: The HTTP response headers. type: string x-order: 9 timestamp: description: The time the delivery was sent, as a Unix epoch timestamp. format: int64 type: integer x-order: 4 required: - duration - id - kind - payload - requestHeaders - requestUrl - responseBody - responseCode - responseHeaders - timestamp type: object UpdateInfo: description: UpdateInfo is an extension to the simpler pulumi CLI's UpdateInfo object. properties: githubCommitInfo: $ref: '#/components/schemas/GitHubCommitInfo' description: 'If the update''s metadata indicates the update environment was from a GitHub based repo we try to lookup the commit that was HEAD at the time of the update. May not be set depending on which API is used to obtain the UpdateInfo object.' x-order: 3 info: $ref: '#/components/schemas/AppUpdateInfo' description: The underlying update information from the Pulumi CLI. x-order: 1 latestVersion: description: LatestVersion of the stack in general. i.e. the latest when Version == LatestVersion. format: int64 type: integer x-order: 5 policyPacks: description: The Policy Packs that were required for this update. items: $ref: '#/components/schemas/AppPolicyPackMetadata' type: array x-order: 7 requestedBy: $ref: '#/components/schemas/UserInfo' description: The user who requested the update. x-order: 6 requestedByToken: description: The access token used to request the update, if applicable. type: string x-order: 8 updateID: description: UpdateID is the underlying Update's ID on the PPC. type: string x-order: 2 version: description: Version of the stack that this UpdateInfo describe. format: int64 type: integer x-order: 4 required: - info - latestVersion - requestedBy - updateID - version type: object DeploymentWithRelatedUpdates: allOf: - $ref: '#/components/schemas/GetDeploymentResponse' - description: DeploymentWithRelatedUpdates extends the deployment response with a list of related updates. properties: updates: description: The list of updates related to this deployment. items: $ref: '#/components/schemas/UpdateInfo' type: array x-order: 1 required: - updates type: object AppStackConfig: description: StackConfig describes the configuration of a stack from Pulumi Cloud. properties: encryptedKey: description: The KMS-encrypted ciphertext for the data key used for secrets encryption. Only used for cloud-based secrets providers. type: string x-order: 3 encryptionSalt: description: The stack's base64-encoded encryption salt. Only used for passphrase-based secrets providers. type: string x-order: 4 environment: description: Reference to ESC environment to use as stack configuration. type: string x-order: 1 secretsProvider: description: The stack's secrets provider. type: string x-order: 2 required: - environment type: object AppBatchDecryptRequest: description: BatchDecryptRequest defines the request body for batch decrypting secret values. properties: ciphertexts: description: List of ciphertexts items: items: format: byte type: string type: array type: array x-order: 1 required: - ciphertexts type: object WebhookResponse: allOf: - $ref: '#/components/schemas/Webhook' - description: WebhookResponse extends Webhook with additional response-only fields. properties: hasSecret: description: 'HasSecret is true if the webhook has a secret. This is used to determine whether to show that there is a secret in the UI.' type: boolean x-order: 1 secretCiphertext: description: 'SecretCiphertext is the ciphertext value of the webhook''s secret. It''s used to check whether the secret was changed by the PSP' type: string x-order: 2 required: - hasSecret - secretCiphertext type: object AppDecryptValueResponse: description: DecryptValueResponse defines the response body for a decrypted value. properties: plaintext: description: The decrypted value. items: format: byte type: string type: array x-order: 1 required: - plaintext type: object UpdateTeamStackPermissionsRequest: description: 'UpdateTeamStackPermissionsRequest modifies the relationship between a stack and a team. (The stack-centric version of UpdateTeamRequest.)' properties: permissions: description: 'Permissions the permissions that team membership grants to the stack. Will overwrite any existing permissions the team grants to the stack. A nil value will remove the stack from the team.' enum: - 0 - 101 - 102 - 103 - 104 format: int64 type: integer x-order: 1 x-pulumi-model-property: enumTypeName: StackPermission enumComments: 'StackPermission is a value describing the permission level a user has for a Pulumi stack. Like OrganizationRole, there is a total ordering of StackPermission values, where each value grants an additional layer of permissions. IMPORTANT: Do not rely on the numeric values for auth checks, instead, just refer to these as opaque names. e.g. use explicit matching in a case-statements instead of "if perm >= StackPermissionX". This prevents errors if we later add a new StackPermission "in between" two existing ones, but with a new, higher value. Previously, the StackPermission value was a series of bit flags, with each bit controlling a specific operation on the stack. However, that proved difficult to describe and maintain. So the newer, "fixed set" approach is used instead. The conversion from the legacy permission values and the new StackPermission values is done transparently, whenever data is read/written to the database. (Converting to the newer values as needed.) We will only be able to remove these legacy values after we deploy the code which can read both formats, and only writes the newer format.' enumFieldNames: - None - Read - Write - Admin - Creator enumFieldComments: - StackPermissionNone provides no access. - 'StackPermissionRead provides read-only access, including the ability to decrypt encrypted configuration secrets stored in the service.' - StackPermissionWrite provides read/write access to a stack. - 'StackPermissionAdmin provides admin-level access to the stack. For example, being able to run `pulumi destroy` or delete the stack.' - 'StackPermissionCreator is an implementation quirk of how we mark the user who created a stack. The value is not exported from this module, and is converted to StackPermissionAdmin before being returned to callers. However, in a few places we want to handle the user who created a stack a little differently, and this allows us to do so without exporting a separate "StackPermissionAdminWhoAlsoHappenedToCreateTheStackToo" value.' type: object AppCancelEvent: description: 'CancelEvent is emitted when the user initiates a cancellation of the update in progress, or the update successfully completes.' type: object AppDeploymentV3: description: 'DeploymentV3 is the third version of the Deployment. It contains newer versions of the Resource and Operation API types and a placeholder for a stack''s secrets configuration. Note that both deployment schema versions 3 and 4 can be unmarshaled into DeploymentV3.' properties: manifest: $ref: '#/components/schemas/AppManifestV1' description: Manifest contains metadata about this deployment. x-order: 1 metadata: $ref: '#/components/schemas/AppSnapshotMetadataV1' description: Metadata associated with the snapshot. x-order: 5 pending_operations: description: PendingOperations are all operations that were known by the engine to be currently executing. items: $ref: '#/components/schemas/AppOperationV2' type: array x-order: 4 resources: description: Resources contains all resources that are currently part of this stack after this deployment has finished. items: $ref: '#/components/schemas/AppResourceV3' type: array x-order: 3 secrets_providers: $ref: '#/components/schemas/AppSecretsProvidersV1' description: SecretsProviders is a placeholder for secret provider configuration. x-order: 2 required: - manifest type: object AppResCustomTimeouts: description: Custom timeout values (in seconds) for resource CRUD operations. properties: create: description: Timeout in seconds for resource creation operations. format: double type: number x-order: 1 delete: description: Timeout in seconds for resource deletion operations. format: double type: number x-order: 3 update: description: Timeout in seconds for resource update operations. format: double type: number x-order: 2 type: object AppPreludeEvent: description: PreludeEvent is emitted at the start of an update. properties: config: additionalProperties: type: string description: Config contains the keys and values for the update. Encrypted configuration values may be blinded. type: object x-order: 1 required: - config type: object AppPatchUpdateCheckpointRequest: description: 'PatchUpdateCheckpointRequest defines the body of a request to the patch update checkpoint endpoint of the service API. The `Deployment` field is expected to contain a serialized `Deployment` value, the schema of which is indicated by the `Version` field.' properties: deployment: description: The deployment data type: object x-order: 4 features: description: The features items: type: string type: array x-order: 3 isInvalid: description: Whether invalid type: boolean x-order: 1 version: description: The version number format: int64 type: integer x-order: 2 required: - isInvalid - version type: object AppStackRenameRequest: description: 'StackRenameRequest is the shape of the request to change an existing stack''s name. If either NewName or NewProject is the empty string, the current project/name will be preserved. (But at least one should be set.)' properties: newName: description: The new name type: string x-order: 1 newProject: description: The new project type: string x-order: 2 required: - newName - newProject type: object Team: description: 'Team describes a Pulumi team. A Pulumi team may have its organization managed by another service, such as GitHub.' properties: accounts: description: The list of account permissions granted to the team. items: $ref: '#/components/schemas/TeamAccountPermission' type: array x-order: 8 description: description: A free-form text description of the team's purpose. type: string x-order: 4 displayName: description: The human-readable display name shown in the UI. type: string x-order: 3 environments: description: The list of environment settings for the team. items: $ref: '#/components/schemas/TeamEnvironmentSettings' type: array x-order: 7 kind: description: The kind of team (e.g., pulumi or GitHub-backed). enum: - github - pulumi - scim type: string x-order: 1 x-pulumi-model-property: enumTypeName: TeamKind enumComments: TeamKind is the kind of team. enumFieldNames: - GitHub - Pulumi - SCIM enumFieldComments: - TeamKindGitHub is for teams where membership is managed by GitHub. - TeamKindPulumi is for teams where membership is managed by Pulumi. - TeamKindSCIM is for SCIM provisioned teams. Membership is managed by its IdP. listMembersError: description: 'ListMembersError is the error message if an error was encountered whilst trying to contact the team''s backend (eg. GitHub). The UI will only show this error if it is non-nil and if Members itself is an empty slice.' type: string x-order: 9 members: description: The list of team members. items: $ref: '#/components/schemas/TeamMemberInfo' type: array x-order: 5 name: description: The unique identifier name of the team within the organization. type: string x-order: 2 roleIds: description: 'RoleIDs are the IDs of the FGA roles assigned to the team, if any. Currently only one role per team is supported.' items: type: string type: array x-order: 11 stacks: description: The list of stack permissions granted to the team. items: $ref: '#/components/schemas/TeamStackPermission' type: array x-order: 6 userRole: description: UserRole is the calling user's role on the given team. enum: - none - member - admin type: string x-order: 10 x-pulumi-model-property: enumTypeName: TeamRole enumComments: TeamRole is the kind of role a user has in a team. required: - description - displayName - kind - name type: object AppPolicyAnalyzeSummaryEvent: description: PolicyAnalyzeSummaryEvent is emitted after a call to Analyze on an analyzer, summarizing the results. properties: failed: description: The names of resource policies that failed (i.e. produced violations). items: type: string type: array x-order: 6 passed: description: The names of resource policies that passed (i.e. did not produce any violations). items: type: string type: array x-order: 5 policyPackName: description: The name of the policy pack. type: string x-order: 2 policyPackVersion: description: The version of the policy pack. type: string x-order: 3 policyPackVersionTag: description: The version tag of the policy pack. type: string x-order: 4 resourceUrn: description: The URN of the resource being analyzed. type: string x-order: 1 required: - policyPackName - policyPackVersion - policyPackVersionTag - resourceUrn type: object AppConfigValue: description: ConfigValue describes a single (possibly secret) configuration value. properties: object: description: Object is true if this value is a JSON encoded object. type: boolean x-order: 3 secret: description: Secret is true if this value is a secret and false otherwise. type: boolean x-order: 2 string: description: 'When Object is false: String is either the plaintext value (for non-secrets) or the base64-encoded ciphertext (for secrets). When Object is true: String is a JSON encoded object. If both Object and Secret are true, then the object contains at least one secure value. Secure values in an object are encoded as `{"secure":"ciphertext"}` where ciphertext is the base64-encoded ciphertext.' type: string x-order: 1 required: - object - secret - string type: object GetStarterWorkflowRequest: description: Request body for generating a starter workflow configuration. properties: ciSystem: description: The CI system to generate the workflow for type: string x-order: 1 enablePathFilters: description: Whether to enable path filters in the workflow type: boolean x-order: 3 workingDirectory: description: The working directory for the workflow type: string x-order: 2 required: - ciSystem - enablePathFilters - workingDirectory type: object DeploymentSourceGit: description: 'DeploymentSourceGit is like SourceContextGit but does not include the Auth data as we don''t want to include that in our deployment response.' properties: branch: description: The branch to deploy from. type: string x-order: 2 commit: description: '(optional) Commit is the hash of the commit to deploy. If used, HEAD will be in detached mode. This is mutually exclusive with the Branch setting. Either value needs to be specified.' type: string x-order: 4 repoDir: description: 'RepoDir is the directory to work from in the project''s source repository where Pulumi.yaml is located. It is used in case Pulumi.yaml is not in the project source root.' type: string x-order: 3 repoURL: description: The URL of the Git repository. type: string x-order: 1 required: - repoURL type: object GetStackUpdatesResponse: description: GetStackUpdatesResponse is the Service-centric view of a Program's update history. properties: itemsPerPage: description: The number of items per page format: int64 type: integer x-order: 2 total: description: The total number of updates format: int64 type: integer x-order: 3 updates: description: The list of stack updates items: $ref: '#/components/schemas/UpdateInfo' type: array x-order: 1 required: - itemsPerPage - total - updates type: object AppManifestV1: description: ManifestV1 captures meta-information about this checkpoint file, such as versions of binaries, etc. properties: magic: description: Magic number, used to identify integrity of the checkpoint. type: string x-order: 2 plugins: description: Plugins contains the binary version info of plug-ins used. items: $ref: '#/components/schemas/AppPluginInfoV1' type: array x-order: 4 time: description: Time of the update. format: date-time type: string x-order: 1 version: description: Version of the Pulumi engine used to render the checkpoint. type: string x-order: 3 required: - magic - time - version type: object ListTeamsByStackResponse: description: ListTeamsByStackResponse lists all teams that have access to a stack. properties: projectName: description: The project name for the stack type: string x-order: 1 teams: description: The list of teams with access to the stack items: $ref: '#/components/schemas/StackTeam' type: array x-order: 2 required: - projectName - teams type: object AppCompleteUpdateRequest: description: CompleteUpdateRequest defines the body of a request to the update completion endpoint of the service API. properties: status: description: The current status enum: - not started - requested - running - failed - succeeded - cancelled type: string x-order: 1 x-pulumi-model-property: enumTypeName: AppUpdateStatus enumComments: UpdateStatus is an enum describing the current state during the lifecycle of an update. enumFieldNames: - NotStarted - Requested - Running - Failed - Succeeded - Cancelled enumFieldComments: - StatusNotStarted is returned when the Update has been created but not applied. - StatusRequested is returned when the Update application has been requested but not started. - StatusRunning is returned when the Update is in progress. - StatusFailed is returned when the update has failed. - StatusSucceeded is returned when the update has succeeded. - UpdateStatusCancelled indicates that an update completed due to cancellation. required: - status type: object GetDeploymentResponse: description: GetDeploymentResponse is the response from the API when getting a single Deployment. properties: configuration: $ref: '#/components/schemas/DeploymentConfiguration' description: Configuration contains the environment variables and source information for a deployment x-order: 9 created: description: Created defines when the Deployment was created. type: string x-order: 2 id: description: Unique identifier for this deployment. type: string x-order: 1 initiator: description: Initiator is the initiation source of the deployment. type: string x-order: 10 jobs: description: Jobs make up all the Jobs of the Deployment. Omitted for deployments that have not started yet. items: $ref: '#/components/schemas/DeploymentJob' type: array x-order: 7 latestVersion: description: LatestVersion is the most recent version number for deployments for the given programID format: int64 type: integer x-order: 8 modified: description: Created defines when the corresponding WorkflowRun was modified. type: string x-order: 3 pulumiOperation: description: PulumiOperation is the operation that was performed. Omitted for historical deployments that predate this field. enum: - update - preview - destroy - refresh - detect-drift - remediate-drift type: string x-order: 11 x-pulumi-model-property: enumTypeName: PulumiOperation enumComments: PulumiOperation describes what operation to perform on the stack as defined in the Job spec. enumFieldNames: - Update - Preview - Destroy - Refresh - DetectDrift - RemediateDrift requestedBy: $ref: '#/components/schemas/UserInfo' description: RequestedBy contains the user information about the user who created the Deployment x-order: 6 status: description: Status is the current status of the workflow runID. enum: - not-started - accepted - running - failed - succeeded - skipped type: string x-order: 4 x-pulumi-model-property: enumTypeName: JobStatus enumComments: JobStatus describes the status of a job run. enumFieldNames: - NotStarted - Accepted - Running - Failed - Succeeded - Skipped enumFieldComments: - JobStatusNotStarted indicates that a job has not yet started. - JobStatusAccepted indicates that a job has been accepted for execution, but is not yet running. - JobStatusRunning indicates that a job is running. - JobStatusFailed indicates that a job has failed. - JobStatusSucceeded indicates that a job has succeeded. - JobStatusSkipped indicates that a job has skipped as there are fresher deployments to execute in the queue. version: description: Version is the ordinal ID for the stack format: int64 type: integer x-order: 5 required: - created - id - latestVersion - modified - requestedBy - status - version type: object AppResourcePreEvent: description: ResourcePreEvent is emitted before a resource is modified. properties: metadata: $ref: '#/components/schemas/AppStepEventMetadata' description: The metadata x-order: 1 planning: description: Whether planning is enabled type: boolean x-order: 2 required: - metadata type: object GetUpdateTimelineResponse: description: GetUpdateTimelineResponse is the response type returning the timeline for a given update. properties: collatedPullRequest: $ref: '#/components/schemas/GitHubPullRequest' description: CollatedPullRequest is the source pull request that was merged, which triggered the stack's update. x-order: 3 collatedUpdateEvents: description: 'CollatedUpdateEvents is the set of update events that are "relevant" to the update. It will contain the sequences of previews that were performed in the same "group", e.g. a GitHub PR, that lead to the final update. If the sequence of previews happened spanned when the stack was updated, e.g. the first preview was at version N - 1 and the last preview was at version N + 1, then the update to stack version N will be included. Will be empty if the update couldn''t be associated with a particular sequence of previews.' items: $ref: '#/components/schemas/UpdateInfo' type: array x-order: 2 previews: description: 'Previews contains all previews for the given stack update that weren''t part of the collated set. For example, from other GitHub pull requests that haven''t been merged, previews ran on developer machines, etc.' items: $ref: '#/components/schemas/UpdateInfo' type: array x-order: 4 update: $ref: '#/components/schemas/UpdateInfo' description: Update is the information about the completed update for the stack. x-order: 1 required: - collatedUpdateEvents - previews - update type: object AppImportStackRequest: description: ImportStackRequest defines the request body for importing a Stack. properties: deployment: description: The opaque Pulumi deployment payload. Treated as a raw JSON value so the contents are preserved verbatim across client and server versions. type: object x-order: 3 features: description: An optional list of features used by this deployment. The CLI will error when reading a deployment that uses a feature that is not supported by that version of the CLI. Only honored when `version` is 4 or greater. items: type: string type: array x-order: 2 version: description: The schema version of the encoded deployment. format: int64 type: integer x-order: 1 type: object TeamAccountPermission: description: TeamAccountPermission is the permission team membership grants to an account. properties: accountName: description: The Insights account name. type: string x-order: 1 permission: description: The permission level the team has on this Insights account. enum: - 0 - 1 - 2 - 3 format: int64 type: integer x-order: 2 x-pulumi-model-property: enumTypeName: InsightsAccountPermission enumComments: InsightsAccountPermission is a value describing the permission level a user has for a Pulumi Insights account. enumFieldNames: - None - Read - Write - Admin enumFieldComments: - InsightsAccountPermissionNone provides no access. - InsightsAccountPermissionRead provides read-only access. - InsightsAccountPermissionWrite provides read/write access to an account. - InsightsAccountPermissionAdmin provides admin-level access to the account. permissionSetName: description: Display name of the permission set for this account, when available. Enables read-only entity access UI without requiring RoleRead. type: string x-order: 3 required: - accountName - permission type: object AppEncryptValueResponse: description: EncryptValueResponse defines the response body for an encrypted value. properties: ciphertext: description: The encrypted value. items: format: byte type: string type: array x-order: 1 required: - ciphertext type: object AppListPolicyGroupsResponse: description: ListPolicyGroupsResponse lists a summary of the organization's Policy Groups. properties: policyGroups: description: List of policy groups items: $ref: '#/components/schemas/AppPolicyGroupSummary' type: array x-order: 1 required: - policyGroups type: object AppJournalEntry: description: Represents app journal entry. properties: deleteNew: description: DeleteNew is the operation ID of the new resource to be marked as deleted. format: int64 type: integer x-order: 10 deleteOld: description: DeleteOld is the index of the resource that's to be marked as deleted. format: int64 type: integer x-order: 9 isRefresh: description: If true, this journal entry is part of a refresh operation. type: boolean x-order: 13 kind: description: Kind of journal entry. enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 format: int64 type: integer x-order: 2 x-pulumi-model-property: enumTypeName: AppJournalEntryKind enumComments: Represents app journal entry kind. enumFieldNames: - Begin - Success - Failure - RefreshSuccess - Outputs - Write - SecretsManager - RebuiltBaseState newSnapshot: $ref: '#/components/schemas/AppDeploymentV3' description: NewSnapshot is the new snapshot that this journal entry is associated with. x-order: 15 operation: $ref: '#/components/schemas/AppOperationV2' description: The operation associated with this journal entry, if any. x-order: 12 operationID: description: ID of the operation this journal entry is associated with. format: int64 type: integer x-order: 4 pendingReplacementNew: description: PendingReplacementNew is the operation ID of the new resource to be marked as pending replacement format: int64 type: integer x-order: 8 pendingReplacementOld: description: PendingReplacementOld is the index of the resource that's to be marked as pending replacement format: int64 type: integer x-order: 7 removeNew: description: ID for the delete Operation that this journal entry is associated with. format: int64 type: integer x-order: 6 removeOld: description: ID for the delete Operation that this journal entry is associated with. format: int64 type: integer x-order: 5 secretsProvider: $ref: '#/components/schemas/AppSecretsProvidersV1' description: The secrets manager associated with this journal entry, if any. x-order: 14 sequenceID: description: Sequence ID of the operation. format: int64 type: integer x-order: 3 state: $ref: '#/components/schemas/AppResourceV3' description: The resource state associated with this journal entry. x-order: 11 version: description: Version of the journal entry format. format: int64 type: integer x-order: 1 required: - kind - operationID - removeNew - removeOld - sequenceID - version type: object GetStackResourceCountResponse: description: GetStackResourceCountResponse returns the number of resources at a particular update. properties: resourceCount: description: The number of resources in the stack format: int64 type: integer x-order: 1 version: description: The update version number format: int64 type: integer x-order: 2 required: - resourceCount - version type: object AppStepEventStateMetadata: description: 'StepEventStateMetadata is the more detailed state information for a resource as it relates to a step(s) being performed.' properties: custom: description: Custom indicates if the resource is managed by a plugin. type: boolean x-order: 3 delete: description: Delete is true when the resource is pending deletion due to a replacement. type: boolean x-order: 4 external: description: True if the resource is external to Pulumi (its lifecycle is managed outside of Pulumi). type: boolean x-order: 14 hideDiffs: description: HideDiffs is the set of property paths where diffs are not displayed. items: type: string type: array x-order: 15 id: description: ID is the resource's unique ID, assigned by the resource provider (or blank if none/uncreated). type: string x-order: 5 initErrors: description: InitErrors is the set of errors encountered in the process of initializing resource. items: type: string type: array x-order: 13 inputs: additionalProperties: type: object description: 'Inputs contains the resource''s input properties (as specified by the program). Secrets have filtered out, and large assets have been replaced by hashes as applicable.' type: object x-order: 10 outputs: additionalProperties: type: object description: Outputs contains the resource's complete output state (as returned by the resource provider). type: object x-order: 11 parent: description: Parent is an optional parent URN that this resource belongs to. type: string x-order: 6 protect: description: Protect is true to "protect" this resource (protected resources cannot be deleted). type: boolean x-order: 7 provider: description: Provider is the resource's provider reference type: string x-order: 12 retainOnDelete: description: RetainOnDelete is true if the resource is not physically deleted when it is logically deleted. type: boolean x-order: 9 taint: description: Taint is set to true when we wish to force it to be replaced upon the next update. type: boolean x-order: 8 type: description: The type type: string x-order: 1 urn: description: The Pulumi URN type: string x-order: 2 required: - id - inputs - outputs - parent - provider - type - urn type: object AppResOutputsEvent: description: ResOutputsEvent is emitted when a resource is finished being provisioned. properties: metadata: $ref: '#/components/schemas/AppStepEventMetadata' description: The metadata x-order: 1 planning: description: Whether planning is enabled type: boolean x-order: 2 required: - metadata type: object AppStdoutEngineEvent: description: 'StdoutEngineEvent is emitted whenever a generic message is written, for example warnings from the pulumi CLI itself. Less common that DiagnosticEvent' properties: color: description: The output color type: string x-order: 2 message: description: The message content type: string x-order: 1 required: - color - message type: object DeploymentSourceTemplate: description: 'DeploymentSourceTemplate is like SourceContextTemplate but does not include the Auth data as we don''t want to include that in the deployment response.' properties: sourceUrl: description: 'The URL of the template source. Supports two URL schemes: **Registry-backed templates** use the `registry://` scheme with the format: `registry://templates/source/publisher/name[@version]` - `source`: The template source identifier (e.g., the registry source name) - `publisher`: The organization or user that published the template - `name`: The template name - `version`: Optional semver version (e.g., `1.0.0`). If omitted, defaults to the latest version Example: `registry://templates/pulumi/acme-corp/aws-vpc@2.1.0` **VCS-backed templates** use standard VCS URLs (GitHub, GitLab, Azure DevOps, etc.): `https://github.com/org/repo`' type: string x-order: 1 required: - sourceUrl type: object AppStackFrameV1: description: StackFrameV1 captures information about a stack frame. properties: sourcePosition: description: SourcePosition contains the source position associated with the stack frame. type: string x-order: 1 type: object UserInfo: description: 'UserInfo contains just the display information for a user. This information may be returned from public APIs, and as such this structure must not contain sensitive information. Please refer to User for this sort of thing.' properties: avatarUrl: description: The URL of the user's avatar image. type: string x-order: 3 email: description: 'IMPORTANT: The email address of the user is only included on a few admin-only APIs. For nearly all APIs that return a UserInfo object, this will not be provided. considered sensitive information.' type: string x-order: 4 githubLogin: description: The user's login name. type: string x-order: 2 name: description: The user's display name. type: string x-order: 1 required: - avatarUrl - githubLogin - name type: object AppDecryptValueRequest: description: DecryptValueRequest defines the request body for decrypting a value. properties: ciphertext: description: The value to decrypt. items: format: byte type: string type: array x-order: 1 required: - ciphertext type: object GetStackActivityResponse: description: GetStackActivityResponse is the Service-centric view of a Program's activity history (deployments and updates). properties: activity: description: The list of activity records for the stack items: $ref: '#/components/schemas/Activity' type: array x-order: 1 itemsPerPage: description: The number of items per page format: int64 type: integer x-order: 2 total: description: The total number of activity records format: int64 type: integer x-order: 3 required: - activity - itemsPerPage - total type: object AppPolicyEvent: description: PolicyEvent is emitted whenever there is Policy violation. properties: color: description: The output color type: string x-order: 3 enforcementLevel: description: EnforcementLevel is one of "warning", "mandatory", "remediate", or "none". type: string x-order: 8 message: description: The message content type: string x-order: 2 policyName: description: The policy name type: string x-order: 4 policyPackName: description: The policy pack name type: string x-order: 5 policyPackVersion: description: The policy pack version type: string x-order: 6 policyPackVersionTag: description: The policy pack version tag type: string x-order: 7 resourceUrn: description: The resource urn type: string x-order: 1 severity: description: 'Severity is one of "low", "medium", "high", or "critical". An empty string is omitted and represents an unspecified severity.' type: string x-order: 9 required: - color - enforcementLevel - message - policyName - policyPackName - policyPackVersion - policyPackVersionTag type: object StackTeam: description: StackTeam is a team that has access to a particular stack. properties: description: description: A description of the team. type: string x-order: 3 displayName: description: The display name of the team. type: string x-order: 2 isMember: description: IsMember is true if the requesting user is a member of the team. type: boolean x-order: 5 name: description: The unique name of the team. type: string x-order: 1 permission: description: The permission level this team has on the stack. enum: - 0 - 101 - 102 - 103 - 104 format: int64 type: integer x-order: 4 x-pulumi-model-property: enumTypeName: StackPermission enumComments: 'StackPermission is a value describing the permission level a user has for a Pulumi stack. Like OrganizationRole, there is a total ordering of StackPermission values, where each value grants an additional layer of permissions. IMPORTANT: Do not rely on the numeric values for auth checks, instead, just refer to these as opaque names. e.g. use explicit matching in a case-statements instead of "if perm >= StackPermissionX". This prevents errors if we later add a new StackPermission "in between" two existing ones, but with a new, higher value. Previously, the StackPermission value was a series of bit flags, with each bit controlling a specific operation on the stack. However, that proved difficult to describe and maintain. So the newer, "fixed set" approach is used instead. The conversion from the legacy permission values and the new StackPermission values is done transparently, whenever data is read/written to the database. (Converting to the newer values as needed.) We will only be able to remove these legacy values after we deploy the code which can read both formats, and only writes the newer format.' enumFieldNames: - None - Read - Write - Admin - Creator enumFieldComments: - StackPermissionNone provides no access. - 'StackPermissionRead provides read-only access, including the ability to decrypt encrypted configuration secrets stored in the service.' - StackPermissionWrite provides read/write access to a stack. - 'StackPermissionAdmin provides admin-level access to the stack. For example, being able to run `pulumi destroy` or delete the stack.' - 'StackPermissionCreator is an implementation quirk of how we mark the user who created a stack. The value is not exported from this module, and is converted to StackPermissionAdmin before being returned to callers. However, in a few places we want to handle the user who created a stack a little differently, and this allows us to do so without exporting a separate "StackPermissionAdminWhoAlsoHappenedToCreateTheStackToo" value.' required: - description - displayName - isMember - name - permission type: object AppPolicyGroupSummary: description: 'PolicyGroupSummary details the name, applicable stacks and the applied Policy Packs for an organization''s Policy Group.' properties: entityType: description: The type of entity this policy group targets (e.g. stacks, accounts). enum: - stacks - accounts type: string x-order: 5 x-pulumi-model-property: enumTypeName: AppEntityType enumComments: EntityType indicates the type of entity a policy group applies to enumFieldComments: - Stacks indicates the policy group applies to stacks - Accounts indicates the policy group applies to accounts isOrgDefault: description: Whether this is the organization's default policy group, applied to all stacks not in another group. type: boolean x-order: 2 mode: description: The enforcement mode of the policy group. enum: - audit - preventative type: string x-order: 6 x-pulumi-model-property: enumTypeName: PolicyGroupMode enumComments: PolicyGroupMode represents the enforcement mode for a policy group name: description: The unique name of the policy group. type: string x-order: 1 numAccounts: description: Number of cloud accounts assigned to this policy group. format: int64 type: integer x-order: 4 numEnabledPolicyPacks: description: Number of policy packs currently enabled in this group. format: int64 type: integer x-order: 7 numStacks: description: Number of stacks assigned to this policy group. format: int64 type: integer x-order: 3 required: - entityType - isOrgDefault - mode - name - numEnabledPolicyPacks - numStacks type: object AppPatchUpdateCheckpointDeltaRequest: description: 'PatchUpdateCheckpointDeltaRequest defines the body of a request to the bandwidth-optimized version of the patch update checkpoint endpoint of the service API. It is semantically equivalent to the PatchUpdateCheckpointRequest, but instead of transferring the entire Deployment as a JSON blob, it encodes it as a textual diff against the last-saved deployment. This conserves bandwidth on large resources.' properties: checkpointHash: description: SHA256 hash of the result of aplying the DeploymentDelta to the previously saved deployment. type: string x-order: 2 deploymentDelta: description: Textual diff that recovers the desired deployment JSON when applied to the previously saved deployment JSON. type: object x-order: 4 sequenceNumber: description: Idempotency key incremented by the client on every PATCH call within the same update. format: int64 type: integer x-order: 3 version: description: Protocol version. format: int64 type: integer x-order: 1 required: - checkpointHash - sequenceNumber - version type: object AppStartUpdateResponse: description: StartUpdateResponse is the result of the command to start an update. properties: journalVersion: description: 'JournalVersion indicates the maximum version of journal entries that should be sent to the server. Is expected to be less or equal than the JournalVersion we sent in the update request. If 0, journaling is disabled.' format: int64 type: integer x-order: 4 token: description: Token is the lease token (if any) to be used to authorize operations on this update. type: string x-order: 2 tokenExpiration: description: TokenExpiration is a UNIX timestamp by which the token will expire. format: int64 type: integer x-order: 3 version: description: 'Version is the version of the program once the update is complete. (Will be the current, unchanged value for previews.)' format: int64 type: integer x-order: 1 required: - version type: object DeploymentConfiguration: description: DeploymentConfiguration contains the configuration for a deployment, including environment variables and source settings. properties: environmentVariables: description: The list of environment variables for the deployment. items: $ref: '#/components/schemas/EnvironmentVariable' type: array x-order: 1 source: $ref: '#/components/schemas/DeploymentSource' description: The source configuration for the deployment. x-order: 2 required: - environmentVariables type: object StackTag: description: StackTag holds the name and value of a single stack tag. properties: name: description: The tag key, which must conform to the stack tag naming rules. enum: - pulumi:project - pulumi:runtime - pulumi:description - pulumi:template - vcs:owner - vcs:repo - vcs:kind - vcs:root type: string x-order: 1 x-pulumi-model-property: enumTypeName: AppStackTagName enumComments: 'StackTagName is the key for the tags bag in stack. This is just a string, but we use a type alias to provide a richer description of how the string is used in our apitype definitions.' enumFieldNames: - ProjectNameTag - ProjectRuntimeTag - ProjectDescriptionTag - ProjectTemplateTag - VCSOwnerNameTag - VCSRepositoryNameTag - VCSRepositoryKindTag - VCSRepositoryRootTag enumFieldComments: - ProjectNameTag is a tag that represents the name of a project (coresponds to the `name` property of Pulumi.yaml). - ProjectRuntimeTag is a tag that represents the runtime of a project (the `runtime` property of Pulumi.yaml). - ProjectDescriptionTag is a tag that represents the description of a project (Pulumi.yaml's `description`). - ProjectTemplateTag is a tag that represents the template that was used to create a project. - 'VCSOwnerNameTag is a tag that represents the name of the owner on the cloud VCS that this stack may be associated with (inferred by the CLI based on git remote info).' - 'VCSRepositoryNameTag is a tag that represents the name of a repository on the cloud VCS that this stack may be associated with (inferred by the CLI based on git remote info).' - 'VCSRepositoryKindTag is a tag that represents the kind of the cloud VCS that this stack may be associated with (inferred by the CLI based on the git remote info).' - 'VCSRepositoryRootTag is a tag that represents the root directory of the repository on the cloud VCS that this stack may be associated with (pulled from git by the CLI)' value: description: The tag value associated with this key. type: string x-order: 2 required: - name - value type: object UpdateSummary: description: UpdateSummary contains a subset of the update data found in apitype.UpdateInfo. properties: endTime: description: The end time of the update as a Unix timestamp. format: int64 type: integer x-order: 3 resourceCount: description: 'ResourceCount is the current resource count for the update. Note that it doesn''t reflect the Stack''s current resource count, only that particular update. (So the UpdateSummary for the same Stack will be different.)' format: int64 type: integer x-order: 4 result: description: The result of the update. enum: - not-started - in-progress - succeeded - failed type: string x-order: 1 x-pulumi-model-property: enumTypeName: AppUpdateResult enumComments: 'UpdateResult is an enum for the result of the update. Should generally mirror backend.UpdateResult, but we clone it in this package to add flexibility in case there is a breaking change in the backend-type.' enumFieldNames: - NotStarted - InProgress - Succeeded - Failed enumFieldComments: - The update has not started. - The update has not yet completed. - The update completed successfully. - The update has failed. startTime: description: The start time of the update as a Unix timestamp. format: int64 type: integer x-order: 2 required: - endTime - resourceCount - result - startTime type: object AppRenewUpdateLeaseResponse: description: RenewUpdateLeaseResponse defines the data returned by the update lease renewal endpoint of the service API. properties: token: description: The renewed token. type: string x-order: 1 tokenExpiration: description: TokenExpiration is a UNIX timestamp by which the token will expire. format: int64 type: integer x-order: 2 required: - token type: object EngineEvent: description: EngineEvent expands apitype.EngineEvent, adding a little more metadata. properties: cancelEvent: $ref: '#/components/schemas/AppCancelEvent' description: Present when `type` is `cancelEvent`. x-order: 3 diagnosticEvent: $ref: '#/components/schemas/AppDiagnosticEvent' description: Present when `type` is `diagnosticEvent`. x-order: 5 errorEvent: $ref: '#/components/schemas/AppErrorEvent' description: Present when `type` is `errorEvent`. x-order: 19 policyAnalyzeStackSummaryEvent: $ref: '#/components/schemas/AppPolicyAnalyzeStackSummaryEvent' description: Present when `type` is `policyAnalyzeStackSummaryEvent`. x-order: 16 policyAnalyzeSummaryEvent: $ref: '#/components/schemas/AppPolicyAnalyzeSummaryEvent' description: Present when `type` is `policyAnalyzeSummaryEvent`. x-order: 14 policyEvent: $ref: '#/components/schemas/AppPolicyEvent' description: Present when `type` is `policyEvent`. x-order: 11 policyLoadEvent: $ref: '#/components/schemas/AppPolicyLoadEvent' description: Present when `type` is `policyLoadEvent`. x-order: 13 policyRemediateSummaryEvent: $ref: '#/components/schemas/AppPolicyRemediateSummaryEvent' description: Present when `type` is `policyRemediateSummaryEvent`. x-order: 15 policyRemediationEvent: $ref: '#/components/schemas/AppPolicyRemediationEvent' description: Present when `type` is `policyRemediationEvent`. x-order: 12 preludeEvent: $ref: '#/components/schemas/AppPreludeEvent' description: Present when `type` is `preludeEvent`. x-order: 6 progressEvent: $ref: '#/components/schemas/AppProgressEvent' description: Present when `type` is `progressEvent`. x-order: 18 resOpFailedEvent: $ref: '#/components/schemas/AppResOpFailedEvent' description: Present when `type` is `resOpFailedEvent`. x-order: 10 resOutputsEvent: $ref: '#/components/schemas/AppResOutputsEvent' description: Present when `type` is `resOutputsEvent`. x-order: 9 resourcePreEvent: $ref: '#/components/schemas/AppResourcePreEvent' description: Present when `type` is `resourcePreEvent`. x-order: 8 startDebuggingEvent: $ref: '#/components/schemas/AppStartDebuggingEvent' description: Present when `type` is `startDebuggingEvent`. x-order: 17 stdoutEvent: $ref: '#/components/schemas/AppStdoutEngineEvent' description: Present when `type` is `stdoutEvent`. x-order: 4 summaryEvent: $ref: '#/components/schemas/AppSummaryEvent' description: Present when `type` is `summaryEvent`. x-order: 7 timestamp: description: Timestamp of the event (seconds). format: int64 type: integer x-order: 1 type: description: 'Type describes which payload object is associated with the event, such that in JavaScript `event[event.type]` is never undefined/null.' type: string x-order: 2 required: - timestamp - type type: object TeamEnvironmentSettings: description: TeamEnvironmentSettings contains additional settings a team applies to an environment. properties: envName: description: The environment within the project. type: string x-order: 2 maxOpenDuration: description: The maximum duration an environment session can remain open, as a Go duration string (e.g. "1h30m"). type: string x-order: 4 permission: description: The permission level the team has on this environment. enum: - none - read - open - write - admin type: string x-order: 3 x-pulumi-model-property: enumTypeName: EnvironmentPermission enumComments: EnvironmentPermission is an enum describing the permission level to access an environment. permissionSetName: description: Display name of the permission set for this environment, when available. Enables read-only entity access UI without requiring RoleRead. type: string x-order: 5 projectName: description: The project containing the environment. type: string x-order: 1 required: - envName - permission - projectName type: object AppStepEventMetadata: description: 'StepEventMetadata describes a "step" within the Pulumi engine, which is any concrete action to migrate a set of cloud resources from one state to another.' properties: detailedDiff: additionalProperties: $ref: '#/components/schemas/AppPropertyDiff' description: The diff for this step as a map of property paths to difference types. An empty map indicates no detailed property-level diff is available; if this field is omitted or null, the diff was not computed. type: object x-order: 8 diffs: description: Keys that changed with this step. items: type: string type: array x-order: 7 keys: description: Keys causing a replacement (only applicable for `create` and `replace` Ops). items: type: string type: array x-order: 6 logical: description: Logical is set if the step is a logical operation in the program. type: boolean x-order: 9 new: $ref: '#/components/schemas/AppStepEventStateMetadata' description: New is the state of the resource after performing the step. x-order: 5 old: $ref: '#/components/schemas/AppStepEventStateMetadata' description: Old is the state of the resource before performing the step. x-order: 4 op: description: Op is the operation being performed. enum: - same - create - update - delete - replace - create-replacement - delete-replaced - read - read-replacement - refresh - discard - discard-replaced - remove-pending-replace - import - import-replacement type: string x-order: 1 x-pulumi-model-property: enumTypeName: AppOpType enumComments: 'OpType describes the type of operation performed to a resource managed by Pulumi. Should generally mirror deploy.StepOp, but we clone it in this package to add flexibility in case there is a breaking change in the backend-type.' enumFieldNames: - OpSame - OpCreate - OpUpdate - OpDelete - OpReplace - OpCreateReplacement - OpDeleteReplaced - OpRead - OpReadReplacement - OpRefresh - OpReadDiscard - OpDiscardReplaced - OpRemovePendingReplace - OpImport - OpImportReplacement enumFieldComments: - OpSame indicates no change was made. - OpCreate indicates a new resource was created. - OpUpdate indicates an existing resource was updated. - OpDelete indicates an existing resource was deleted. - OpReplace indicates an existing resource was replaced with a new one. - OpCreateReplacement indicates a new resource was created for a replacement. - OpDeleteReplaced indicates an existing resource was deleted after replacement. - OpRead indicates reading an existing resource. - OpReadReplacement indicates reading an existing resource for a replacement. - OpRefresh indicates refreshing an existing resource. - OpReadDiscard indicates removing a resource that was read. - OpDiscardReplaced indicates discarding a read resource that was replaced. - OpRemovePendingReplace indicates removing a pending replace resource. - OpImport indicates importing an existing resource. - OpImportReplacement indicates replacement of an existing resource with an imported resource. provider: description: Provider actually performing the step. type: string x-order: 10 type: description: The type type: string x-order: 3 urn: description: The Pulumi URN type: string x-order: 2 required: - detailedDiff - new - old - op - provider - type - urn type: object AppErrorEvent: description: 'ErrorEvent is emitted when an internal error occurs in the engine. This is not meant to be used for user facing errors, but rather for internal errors, where an event can help with debugging.' properties: error: description: Error is the error message. type: string x-order: 1 required: - error type: object AppUpdateProgramRequest: description: UpdateProgramRequest is the request type for updating (aka deploying) a Pulumi program. properties: config: additionalProperties: $ref: '#/components/schemas/AppConfigValue' description: Configuration values. type: object x-order: 6 description: description: The description type: string x-order: 4 main: description: The main entry point type: string x-order: 3 metadata: $ref: '#/components/schemas/AppUpdateMetadata' description: The metadata x-order: 7 name: description: Properties from the Project file. Subset of pack.Package. type: string x-order: 1 options: $ref: '#/components/schemas/AppUpdateOptions' description: The options x-order: 5 runtime: description: The runtime type: string x-order: 2 required: - config - description - main - metadata - name - options - runtime type: object AppUpdateMetadata: description: 'UpdateMetadata describes optional metadata about an update. Should generally mirror backend.UpdateMetadata, but we clone it in this package to add flexibility in case there is a breaking change in the backend-type.' properties: environment: additionalProperties: type: string description: 'Environment contains optional data from the deploying environment. e.g. the current source code control commit information.' type: object x-order: 2 message: description: Message is an optional message associated with the update. type: string x-order: 1 required: - environment - message type: object GetUpdateEventsResponse: description: GetUpdateEventsResponse contains the engine events for am update. properties: continuationToken: description: 'ContinuationToken is an opaque value the client can send to fetch more recent events if the update is still in progress. Will be nil once all events have been returned and the update is complete.' type: string x-order: 2 events: description: 'Events are returned sorted by their internal sequence number (not exposed to the API). So the last Event in the slice is the most recent event which was stored in the database. (Should sort identical to timestamp, but may not if we support parallel writes.)' items: $ref: '#/components/schemas/EngineEvent' type: array x-order: 1 required: - continuationToken - events type: object AppPolicyLoadEvent: description: PolicyLoadEvent is emitted when a policy starts loading type: object AppBatchDecryptResponse: description: 'BatchDecryptResponse defines the response body for batch decrypted secret values. The key in the map is the base64 encoding of the ciphertext.' properties: plaintexts: additionalProperties: items: format: byte type: string type: array description: Map of plaintexts type: object x-order: 1 required: - plaintexts type: object AppAISettingsForUpdate: description: Settings for updating AI/Copilot configuration on a stack. properties: copilotIsEnabled: description: Whether the Pulumi Copilot AI assistant is enabled for this stack. type: boolean x-order: 1 required: - copilotIsEnabled type: object AppAppendUpdateLogEntryRequest: description: 'AppendUpdateLogEntryRequest defines the body of a request to the append update log entry endpoint of the service API. No longer sent from the CLI, but the type definition is still required for backwards compat with older clients.' properties: fields: additionalProperties: type: object description: The fields type: object x-order: 2 kind: description: The kind type: string x-order: 1 required: - fields - kind type: object TeamPermission: description: TeamPermission describes the team and the stack permission that team has for a specific stack. properties: permission: description: The permission level the team has on the stack (e.g., read, write, admin). enum: - 0 - 101 - 102 - 103 - 104 format: int64 type: integer x-order: 2 x-pulumi-model-property: enumTypeName: StackPermission enumComments: 'StackPermission is a value describing the permission level a user has for a Pulumi stack. Like OrganizationRole, there is a total ordering of StackPermission values, where each value grants an additional layer of permissions. IMPORTANT: Do not rely on the numeric values for auth checks, instead, just refer to these as opaque names. e.g. use explicit matching in a case-statements instead of "if perm >= StackPermissionX". This prevents errors if we later add a new StackPermission "in between" two existing ones, but with a new, higher value. Previously, the StackPermission value was a series of bit flags, with each bit controlling a specific operation on the stack. However, that proved difficult to describe and maintain. So the newer, "fixed set" approach is used instead. The conversion from the legacy permission values and the new StackPermission values is done transparently, whenever data is read/written to the database. (Converting to the newer values as needed.) We will only be able to remove these legacy values after we deploy the code which can read both formats, and only writes the newer format.' enumFieldNames: - None - Read - Write - Admin - Creator enumFieldComments: - StackPermissionNone provides no access. - 'StackPermissionRead provides read-only access, including the ability to decrypt encrypted configuration secrets stored in the service.' - StackPermissionWrite provides read/write access to a stack. - 'StackPermissionAdmin provides admin-level access to the stack. For example, being able to run `pulumi destroy` or delete the stack.' - 'StackPermissionCreator is an implementation quirk of how we mark the user who created a stack. The value is not exported from this module, and is converted to StackPermissionAdmin before being returned to callers. However, in a few places we want to handle the user who created a stack a little differently, and this allows us to do so without exporting a separate "StackPermissionAdminWhoAlsoHappenedToCreateTheStackToo" value.' team: $ref: '#/components/schemas/Team' description: The team that has been granted access to the stack. x-order: 1 required: - permission - team type: object AppStartDebuggingEvent: description: StartDebuggingEvent is emitted to start a debugging session. properties: config: additionalProperties: type: object description: The configuration type: object x-order: 1 type: object ListDownstreamStackReferencesResponse: description: ListDownstreamStackReferencesResponse is the response to list downstream references of a particular stack. properties: referencedStacks: description: The list of downstream stack references items: $ref: '#/components/schemas/StackReference' type: array x-order: 1 required: - referencedStacks type: object AppUpdateOptions: description: 'UpdateOptions is the set of operations for configuring the output of an update. Should generally mirror engine.UpdateOptions, but we clone it in this package to add flexibility in case there is a breaking change in the engine-type.' properties: color: description: Terminal color mode for output rendering (e.g. 'always', 'never', 'auto'). type: string x-order: 2 debug: description: If true, enable verbose debug logging during the update. type: boolean x-order: 9 dryRun: description: If true, perform a preview without actually applying changes. type: boolean x-order: 3 localPolicyPackPaths: description: File system paths to local policy packs to apply during this update. items: type: string type: array x-order: 1 parallel: description: Maximum number of resource operations to perform in parallel. 0 or -1 for unlimited. format: int32 type: integer x-order: 4 showConfig: description: If true, include configuration values in the update output. type: boolean x-order: 5 showNames: description: If true, include unchanged resources in the update output. type: boolean x-order: 7 showReplacementSteps: description: If true, include detailed replacement steps in the update output. type: boolean x-order: 6 summary: description: If true, only show a summary of changes rather than full details. type: boolean x-order: 8 required: - color - debug - dryRun - localPolicyPackPaths - parallel - showConfig - showNames - showReplacementSteps - summary type: object