How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pulumi Stacks API

The Stacks API from Pulumi — 98 operation(s) for stacks.

Pulumi Stacks API is one of 35 APIs that Pulumi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Stacks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 115 operations across 98 paths, and defines 125 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.pulumi.com.

115 operations 98 paths 125 schemas 5 DELETE43 GET19 PATCH47 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.pulumi.com
Resource Areas
1

Paths & Operations 115

Across 98 paths, the API surfaces 115 operations — 5 DELETE, 43 GET, 19 PATCH, 47 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Stacks 115
GET
/api/console/orgs/{orgName}/members/{userLogin}/stacks/{projectName}/{stackName}
ListMemberStackPermissions
ListMemberStackPermissions 4 params → 200404
GET
/api/console/stacks/{orgName}/{projectName}/{stackName}/overview
GetStackOverview
GetStackOverview 3 params → 200
PATCH
/api/console/stacks/{orgName}/{projectName}/{stackName}/teams/{teamName}
UpdateTeamStackPermissions
UpdateTeamStackPermissions 4 params body → 204400403404
GET
/api/console/stacks/{orgName}/{projectName}/{stackName}/updates/latest/summary
UpdateSummaryHandlerLatest
UpdateSummaryHandlerLatest 3 params → 200404
GET
/api/console/stacks/{orgName}/{projectName}/{stackName}/updates/{updateID}/summary
UpdateSummary
UpdateSummary 4 params → 200404
DELETE
/api/stacks/{orgName}/{projectName}/{stackName}
DeleteStack
DeleteStack 4 params → 204400
GET
/api/stacks/{orgName}/{projectName}/{stackName}
GetStack
GetStack 3 params → 200
GET
/api/stacks/{orgName}/{projectName}/{stackName}/activity
GetStackActivity
GetStackActivity 5 params → 200400
GET
/api/stacks/{orgName}/{projectName}/{stackName}/annotations/{kind}
GetStacksAnnotation
GetStacksAnnotation 6 params → 200404
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/annotations/{kind}
UpsertStacksAnnotations
UpsertStacksAnnotations 6 params body → 204409
POST
/api/stacks/{orgName}/{projectName}/{stackName}/batch-decrypt
BatchDecryptValue
BatchDecryptValue 3 params body → 200400404413
POST
/api/stacks/{orgName}/{projectName}/{stackName}/batch-encrypt
BatchEncryptValue
BatchEncryptValue 3 params body → 200413
GET
/api/stacks/{orgName}/{projectName}/{stackName}/collaboratorsdeprecated
ListStackPermissions
ListStackPermissions 3 params → 200
DELETE
/api/stacks/{orgName}/{projectName}/{stackName}/collaborators/{userName}
DeleteStackPermission
DeleteStackPermission 4 params → 204404
DELETE
/api/stacks/{orgName}/{projectName}/{stackName}/config
DeleteStackConfig
DeleteStackConfig 3 params → 204
GET
/api/stacks/{orgName}/{projectName}/{stackName}/config
GetStackConfig
GetStackConfig 3 params → 200404
PUT
/api/stacks/{orgName}/{projectName}/{stackName}/config
UpdateStackConfig
UpdateStackConfig 3 params body → 200400
POST
/api/stacks/{orgName}/{projectName}/{stackName}/decrypt
DecryptValue
DecryptValue 3 params body → 200413
POST
/api/stacks/{orgName}/{projectName}/{stackName}/decrypt/log-batch-decryption
LogOnlyBatchDecryptValue
LogOnlyBatchDecryptValue 3 params body → 204
POST
/api/stacks/{orgName}/{projectName}/{stackName}/decrypt/log-decryption
LogOnlyDecryptValue
LogOnlyDecryptValue 3 params body → 204
POST
/api/stacks/{orgName}/{projectName}/{stackName}/destroy
CreateUpdateForDestroy
CreateUpdateForDestroy 3 params body → 200
GET
/api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}
GetUpdateStatusForDestroy
GetUpdateStatusForDestroy 5 params → 200400
POST
/api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}
StartUpdateForDestroy
StartUpdateForDestroy 4 params body → 200404409
POST
/api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/cancel
CancelUpdate
CancelUpdate_destroy 4 params → 204404409
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/checkpoint
PatchUpdateCheckpoint
PatchUpdateCheckpoint_destroy 4 params body → 204400403409
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/checkpointdelta
PatchUpdateCheckpointDelta
PatchUpdateCheckpointDelta_destroy 4 params body → 204400403409
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/checkpointverbatim
PatchUpdateVerbatimCheckpoint
PatchUpdateVerbatimCheckpoint_destroy 4 params body → 204400403409
POST
/api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/complete
CompleteUpdate
CompleteUpdate_destroy 4 params body → 204400404409
GET
/api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/events
GetEngineEvents
GetEngineEvents_destroy 8 params → 200400
POST
/api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/events
RecordEngineEvent
RecordEngineEvent_destroy 4 params body → 200400404
POST
/api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/events/batch
RecordEngineEventBatch
RecordEngineEventBatch_destroy 4 params body → 200400404
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/journalentries
CreateJournalEntries
CreateJournalEntries_destroy 5 params body → 204
POST
/api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/log
AppendUpdateLogEntry
AppendUpdateLogEntry_destroy 4 params body → 204
POST
/api/stacks/{orgName}/{projectName}/{stackName}/destroy/{updateID}/renew_lease
RenewUpdateLease
RenewUpdateLease_destroy 4 params body → 200400409
GET
/api/stacks/{orgName}/{projectName}/{stackName}/downstreamreferences
ListDownstreamStackReferences
ListDownstreamStackReferences 3 params → 200
POST
/api/stacks/{orgName}/{projectName}/{stackName}/encrypt
EncryptValue
EncryptValue 3 params body → 200413
GET
/api/stacks/{orgName}/{projectName}/{stackName}/export
ExportStack
ExportStack 3 params → 200
GET
/api/stacks/{orgName}/{projectName}/{stackName}/export/{version}
ExportStackAtVersion
ExportStackAtVersion 4 params → 200400404
GET
/api/stacks/{orgName}/{projectName}/{stackName}/hooks
ListStackWebhooks
ListStackWebhooks 3 params → 200
POST
/api/stacks/{orgName}/{projectName}/{stackName}/hooks
CreateStackWebhook
CreateStackWebhook 3 params body → 201400409
DELETE
/api/stacks/{orgName}/{projectName}/{stackName}/hooks/{hookName}
DeleteStackWebhook
DeleteStackWebhook 4 params → 204
GET
/api/stacks/{orgName}/{projectName}/{stackName}/hooks/{hookName}
GetStackWebhook
GetStackWebhook 4 params → 200404
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/hooks/{hookName}
UpdateStackWebhook
UpdateStackWebhook 4 params body → 200400404
GET
/api/stacks/{orgName}/{projectName}/{stackName}/hooks/{hookName}/deliveries
GetStackWebhookDeliveries
GetStackWebhookDeliveries 4 params → 200
POST
/api/stacks/{orgName}/{projectName}/{stackName}/hooks/{hookName}/deliveries/{event}/redeliver
RedeliverStackWebhookEvent
RedeliverStackWebhookEvent 5 params → 200404
POST
/api/stacks/{orgName}/{projectName}/{stackName}/hooks/{hookName}/ping
PingStackWebhook
PingStackWebhook 4 params → 200404
POST
/api/stacks/{orgName}/{projectName}/{stackName}/import
ImportStack
ImportStack 3 params body → 200400409
GET
/api/stacks/{orgName}/{projectName}/{stackName}/metadata
GetStackMetadata
GetStackMetadata 3 params → 200
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/notifications/settings
UpdateStackNotificationSettings
UpdateStackNotificationSettings 3 params body → 200
POST
/api/stacks/{orgName}/{projectName}/{stackName}/ownership
ReassignStackOwnership
ReassignStackOwnership 3 params body → 200
GET
/api/stacks/{orgName}/{projectName}/{stackName}/policygroups
GetStackPolicyGroups
GetStackPolicyGroups 3 params → 200
GET
/api/stacks/{orgName}/{projectName}/{stackName}/policypacks
GetStackPolicyPacks
GetStackPolicyPacks 4 params → 200400
POST
/api/stacks/{orgName}/{projectName}/{stackName}/preview
CreateUpdateForPreview
CreateUpdateForPreview 3 params body → 200
GET
/api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}
GetUpdateStatusForPreview
GetUpdateStatusForPreview 5 params → 200400
POST
/api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}
StartUpdateForPreview
StartUpdateForPreview 4 params body → 200404409
POST
/api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/cancel
CancelUpdate
CancelUpdate_preview 4 params → 204404409
POST
/api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/complete
CompleteUpdate
CompleteUpdate_preview 4 params body → 204400404409
GET
/api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/events
GetEngineEvents
GetEngineEvents_preview 8 params → 200400
POST
/api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/events
RecordEngineEvent
RecordEngineEvent_preview 4 params body → 200400404
POST
/api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/events/batch
RecordEngineEventBatch
RecordEngineEventBatch_preview 4 params body → 200400404
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/journalentries
CreateJournalEntries
CreateJournalEntries_preview 5 params body → 204
POST
/api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/log
AppendUpdateLogEntry
AppendUpdateLogEntry_preview 4 params body → 204
POST
/api/stacks/{orgName}/{projectName}/{stackName}/preview/{updateID}/renew_lease
RenewUpdateLease
RenewUpdateLease_preview 4 params body → 200400409
GET
/api/stacks/{orgName}/{projectName}/{stackName}/previews/{updateID}
GetStackPreview
GetStackPreview 4 params → 200404
GET
/api/stacks/{orgName}/{projectName}/{stackName}/previews/{updateID}/summary
GetStackPreviewSummary
GetStackPreviewSummary 4 params → 200404
POST
/api/stacks/{orgName}/{projectName}/{stackName}/refresh
CreateUpdateForRefresh
CreateUpdateForRefresh 3 params body → 200
GET
/api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}
GetUpdateStatusForRefresh
GetUpdateStatusForRefresh 5 params → 200400
POST
/api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}
StartUpdateForRefresh
StartUpdateForRefresh 4 params body → 200404409
POST
/api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/cancel
CancelUpdate
CancelUpdate_refresh 4 params → 204404409
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/checkpoint
PatchUpdateCheckpoint
PatchUpdateCheckpoint_refresh 4 params body → 204400403409
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/checkpointdelta
PatchUpdateCheckpointDelta
PatchUpdateCheckpointDelta_refresh 4 params body → 204400403409
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/checkpointverbatim
PatchUpdateVerbatimCheckpoint
PatchUpdateVerbatimCheckpoint_refresh 4 params body → 204400403409
POST
/api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/complete
CompleteUpdate
CompleteUpdate_refresh 4 params body → 204400404409
GET
/api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/events
GetEngineEvents
GetEngineEvents_refresh 8 params → 200400
POST
/api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/events
RecordEngineEvent
RecordEngineEvent_refresh 4 params body → 200400404
POST
/api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/events/batch
RecordEngineEventBatch
RecordEngineEventBatch_refresh 4 params body → 200400404
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/journalentries
CreateJournalEntries
CreateJournalEntries_refresh 5 params body → 204
POST
/api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/log
AppendUpdateLogEntry
AppendUpdateLogEntry_refresh 4 params body → 204
POST
/api/stacks/{orgName}/{projectName}/{stackName}/refresh/{updateID}/renew_lease
RenewUpdateLease
RenewUpdateLease_refresh 4 params body → 200400409
POST
/api/stacks/{orgName}/{projectName}/{stackName}/rename
RenameStack
RenameStack 3 params body → 200400409
GET
/api/stacks/{orgName}/{projectName}/{stackName}/resources/count
GetStackResourceCount
GetStackResourceCount 3 params → 200
GET
/api/stacks/{orgName}/{projectName}/{stackName}/resources/latest
GetLatestStackResources
GetLatestStackResources 3 params → 200
GET
/api/stacks/{orgName}/{projectName}/{stackName}/resources/latest/{urn}
GetLatestStackResource
GetLatestStackResource 4 params → 200404
GET
/api/stacks/{orgName}/{projectName}/{stackName}/resources/{version}
GetStackResources
GetStackResources 4 params → 200404
GET
/api/stacks/{orgName}/{projectName}/{stackName}/resources/{version}/{urn}
GetStackResource
GetStackResource 5 params → 200404
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/tags
UpdateStackTags
UpdateStackTags 3 params body → 204400
POST
/api/stacks/{orgName}/{projectName}/{stackName}/tags
AddStackTag
AddStackTag 3 params body → 204400
DELETE
/api/stacks/{orgName}/{projectName}/{stackName}/tags/{tagName}
DeleteStackTag
DeleteStackTag 4 params → 204400404
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/tags/{tagName}
UpdateStackTag
UpdateStackTag 4 params body → 204400404
GET
/api/stacks/{orgName}/{projectName}/{stackName}/teams
ListStackTeams
ListStackTeams 3 params → 200
POST
/api/stacks/{orgName}/{projectName}/{stackName}/transfer
TransferStack
TransferStack 3 params body → 204409
POST
/api/stacks/{orgName}/{projectName}/{stackName}/update
CreateUpdateForUpdate
CreateUpdateForUpdate 3 params body → 200
GET
/api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}
GetUpdateStatusForUpdate
GetUpdateStatusForUpdate 5 params → 200400
POST
/api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}
StartUpdateForUpdate
StartUpdateForUpdate 4 params body → 200404409
POST
/api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/cancel
CancelUpdate
CancelUpdate_update 4 params → 204404409
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/checkpoint
PatchUpdateCheckpoint
PatchUpdateCheckpoint_update 4 params body → 204400403409
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/checkpointdelta
PatchUpdateCheckpointDelta
PatchUpdateCheckpointDelta_update 4 params body → 204400403409
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/checkpointverbatim
PatchUpdateVerbatimCheckpoint
PatchUpdateVerbatimCheckpoint_update 4 params body → 204400403409
POST
/api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/complete
CompleteUpdate
CompleteUpdate_update 4 params body → 204400404409
GET
/api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/events
GetEngineEvents
GetEngineEvents_update 8 params → 200400
POST
/api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/events
RecordEngineEvent
RecordEngineEvent_update 4 params body → 200400404
POST
/api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/events/batch
RecordEngineEventBatch
RecordEngineEventBatch_update 4 params body → 200400404
PATCH
/api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/journalentries
CreateJournalEntries
CreateJournalEntries_update 5 params body → 204
POST
/api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/log
AppendUpdateLogEntry
AppendUpdateLogEntry_update 4 params body → 204
POST
/api/stacks/{orgName}/{projectName}/{stackName}/update/{updateID}/renew_lease
RenewUpdateLease
RenewUpdateLease_update 4 params body → 200400409
GET
/api/stacks/{orgName}/{projectName}/{stackName}/updates
GetStackUpdates
GetStackUpdates 6 params → 200400
GET
/api/stacks/{orgName}/{projectName}/{stackName}/updates/latest
GetLatestStackUpdate
GetLatestStackUpdate 3 params → 200404
GET
/api/stacks/{orgName}/{projectName}/{stackName}/updates/latest/previews
GetLatestStackPreviews
GetLatestStackPreviews 6 params → 200400
GET
/api/stacks/{orgName}/{projectName}/{stackName}/updates/latest/timeline
GetLatestUpdateTimeline
GetLatestUpdateTimeline 3 params → 200404
GET
/api/stacks/{orgName}/{projectName}/{stackName}/updates/{version}
GetStackUpdate
GetStackUpdate 4 params → 200404
GET
/api/stacks/{orgName}/{projectName}/{stackName}/updates/{version}/previews
GetStackPreviews
GetStackPreviews 7 params → 200400
GET
/api/stacks/{orgName}/{projectName}/{stackName}/updates/{version}/summary
GetStackUpdateSummary
GetStackUpdateSummary 4 params → 200404
GET
/api/stacks/{orgName}/{projectName}/{stackName}/updates/{version}/timeline
GetUpdateTimeline
GetUpdateTimeline 4 params → 200404
GET
/api/stacks/{orgName}/{projectName}/{stackName}/upstreamreferences
ListUpstreamStackReferences
ListUpstreamStackReferences 3 params → 200
POST
/api/stacks/{orgName}/{projectName}/{stackName}/workflow
GetStackStarterWorkflow
GetStackStarterWorkflow 3 params body → 200400404

Schemas 125

The contract defines 125 schemas that model the data the API accepts and returns. The most detailed are AppResourceV3 (34 properties), EngineEvent (19 properties), AppEngineEvent (19 properties), Resource (17 properties). Each schema is shown below with its type and property counts.

GetStackUpdatesResponse
object
GetStackUpdatesResponse is the Service-centric view of a Program's update history.
3 properties 3 required
GitHubPullRequest
object
GitHubPullRequest describes a GitHub pull request that a stack update was associated with.
9 properties 7 required
GetStackResourcesResponse
object
GetStackResourcesResponse returns the resources for a stack at a particular update.
3 properties 3 required
AppUpdateProgramResponse
object
UpdateProgramResponse is the result of an update program request.
4 properties 1 required
AppStartUpdateRequest
object
StartUpdateRequest requests that an update starts getting applied to a stack.
2 properties
StackTag
object
StackTag holds the name and value of a single stack tag.
2 properties 2 required
StackMetadata
object
StackMetadata returns metadata about a stack.
5 properties 5 required
UpdateSummary
object
UpdateSummary contains a subset of the update data found in apitype.UpdateInfo.
4 properties 4 required
AppPatchUpdateVerbatimCheckpointRequest
object
PatchUpdateVerbatimCheckpointRequest defines the body of a request to a patch update checkpoint endpoint of the service API, where UntypedDeloyment is an apity…
3 properties 2 required
AppResourceV3
object
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 tha…
34 properties 3 required
AppEngineEvent
object
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 t…
19 properties 2 required
AppRenewUpdateLeaseRequest
object
RenewUpdateLeaseRequest defines the body of a request to the update lease renewal endpoint of the service API.
2 properties 2 required
TeamMemberInfo
AppSummaryEvent
object
SummaryEvent is emitted at the end of an update, with a summary of the changes made.
5 properties 5 required
AppJournalEntries
object
Collection of app journal entries.
1 property
AppPatchUpdateCheckpointRequest
object
PatchUpdateCheckpointRequest defines the body of a request to the patch update checkpoint endpoint of the service API. The Deployment field is expected to cont…
4 properties 2 required
DeploymentSourceGit
object
DeploymentSourceGit is like SourceContextGit but does not include the Auth data as we don't want to include that in our deployment response.
4 properties 1 required
AppErrorEvent
object
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 a…
1 property 1 required
AppPolicyLoadEvent
object
PolicyLoadEvent is emitted when a policy starts loading
AppCancelEvent
object
CancelEvent is emitted when the user initiates a cancellation of the update in progress, or the update successfully completes.
AppUpdateMetadata
object
UpdateMetadata describes optional metadata about an update. Should generally mirror backend.UpdateMetadata, but we clone it in this package to add flexibility…
2 properties 2 required
WebhookDelivery
object
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.Webhoo…
10 properties 10 required
AppCompleteUpdateRequest
object
CompleteUpdateRequest defines the body of a request to the update completion endpoint of the service API.
1 property 1 required
GetStarterWorkflowRequest
object
Request body for generating a starter workflow configuration.
3 properties 3 required
UpdateInfo
object
UpdateInfo is an extension to the simpler pulumi CLI's UpdateInfo object.
8 properties 5 required
AppListPolicyGroupsResponse
object
ListPolicyGroupsResponse lists a summary of the organization's Policy Groups.
1 property 1 required
AppUpdateEvent
object
UpdateEvent describes an event that happened on the Pulumi Cloud while processing an update.
3 properties 3 required
AppDecryptValueRequest
object
DecryptValueRequest defines the request body for decrypting a value.
1 property 1 required
AppOperationStatus
object
OperationStatus describes the state of an operation being performed on a Pulumi stack.
3 properties 3 required
AppAppendUpdateLogEntryRequest
object
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…
2 properties 2 required
AppManifestV1
object
ManifestV1 captures meta-information about this checkpoint file, such as versions of binaries, etc.
4 properties 3 required
AppRenewUpdateLeaseResponse
object
RenewUpdateLeaseResponse defines the data returned by the update lease renewal endpoint of the service API.
2 properties 1 required
WebhookResponse
DeploymentSourceTemplate
object
DeploymentSourceTemplate is like SourceContextTemplate but does not include the Auth data as we don't want to include that in the deployment response.
1 property 1 required
AppEncryptValueResponse
object
EncryptValueResponse defines the response body for an encrypted value.
1 property 1 required
AppEncryptValueRequest
object
EncryptValueRequest defines the request body for encrypting a value.
1 property 1 required
GetStackResourceCountResponse
object
GetStackResourceCountResponse returns the number of resources at a particular update.
2 properties 2 required
GetUpdateEventsResponse
object
GetUpdateEventsResponse contains the engine events for am update.
2 properties 2 required
ListTeamsByStackResponse
object
ListTeamsByStackResponse lists all teams that have access to a stack.
2 properties 2 required
AppDeploymentV3
object
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…
5 properties 1 required
AppPolicyRemediateSummaryEvent
object
PolicyRemediateSummaryEvent is emitted after a call to Remediate on an analyzer, summarizing the results.
6 properties 4 required
AppBatchDecryptResponse
object
BatchDecryptResponse defines the response body for batch decrypted secret values. The key in the map is the base64 encoding of the ciphertext.
1 property 1 required
AppConfigValue
object
ConfigValue describes a single (possibly secret) configuration value.
3 properties 3 required
AppDiagnosticEvent
object
DiagnosticEvent is emitted whenever a diagnostic message is provided, for example errors from a cloud resource provider while trying to create or update a reso…
7 properties 3 required
GetStackActivityResponse
object
GetStackActivityResponse is the Service-centric view of a Program's activity history (deployments and updates).
3 properties 3 required
AppRequiredPolicy
object
RequiredPolicy is the information regarding a particular Policy that is required by an organization.
7 properties 4 required
AppPolicyPackMetadata
object
PolicyPackMetadata is the metadata of a Policy Pack.
6 properties 4 required
AppPluginInfoV1
object
PluginInfoV1 captures the version and information about a plugin.
4 properties 4 required
AppStackConfig
object
StackConfig describes the configuration of a stack from Pulumi Cloud.
4 properties 1 required
AppSecretsProvidersV1
object
Represents app secrets providers v1.
2 properties 1 required
UserPermission
object
UserPermission describes a user's permission level for a stack.
2 properties 2 required
AppPreludeEvent
object
PreludeEvent is emitted at the start of an update.
1 property 1 required
ListMemberStackPermissionsResponse
object
ListMemberStackPermissionsResponse describes all the permissions that have been set for a user for a specific stack.
5 properties 5 required
TeamAccountPermission
object
TeamAccountPermission is the permission team membership grants to an account.
3 properties 2 required
AppStackRenameRequest
object
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/nam…
2 properties 2 required
AppStartUpdateResponse
object
StartUpdateResponse is the result of the command to start an update.
4 properties 1 required
AppResourcePreEvent
object
ResourcePreEvent is emitted before a resource is modified.
2 properties 1 required
AppStdoutEngineEvent
object
StdoutEngineEvent is emitted whenever a generic message is written, for example warnings from the pulumi CLI itself. Less common that DiagnosticEvent
2 properties 2 required
AppSnapshotMetadataV1
object
SnapshotMetadataV1 contains metadata about a deployment snapshot.
1 property
AppPolicyEvent
object
PolicyEvent is emitted whenever there is Policy violation.
9 properties 7 required
AppResOpFailedEvent
object
ResOpFailedEvent is emitted when a resource operation fails. Typically a DiagnosticEvent is emitted before this event, indicating the root cause of the error.
3 properties 3 required
ResourceInfo
object
ResourceInfo wraps a basic resource and provides contextual information.
1 property 1 required
GetStackResourceResponse
object
GetStackResourceResponse returns a single resource for a stack at a particular update.
3 properties 3 required
EnvironmentVariable
object
EnvironmentVariable is a key-value pair; if the variable is secret, value will be empty/omitted.
3 properties 2 required
AppStepEventMetadata
object
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.
10 properties 7 required
AppAISettingsForUpdate
object
Settings for updating AI/Copilot configuration on a stack.
1 property 1 required
ConsoleUpdateSummary
object
A human readable summary of the update, in the same manner as generated by the CLI via commands such as pulumi up.
1 property 1 required
UserInfo
object
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 sensi…
4 properties 3 required
TransferStackRequest
object
TransferStackRequest request object for transferring ownership of a stack between two organizations.
4 properties 1 required
ListStackCollaboratorsResponse
object
ListStackCollaboratorsResponse is the response when querying a stack's collaborators.
2 properties 1 required
AppPolicyAnalyzeStackSummaryEvent
object
PolicyAnalyzeStackSummaryEvent is emitted after a call to AnalyzeStack on an analyzer, summarizing the results.
5 properties 3 required
Resource
object
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 ty…
17 properties 5 required
DeploymentSource
object
DeploymentSource describes the source of a deployment, which may be a Git repository or a template.
2 properties
TeamPermission
object
TeamPermission describes the team and the stack permission that team has for a specific stack.
2 properties 2 required
AppPatchUpdateCheckpointDeltaRequest
object
PatchUpdateCheckpointDeltaRequest defines the body of a request to the bandwidth-optimized version of the patch update checkpoint endpoint of the service API.…
4 properties 3 required
AppStack
object
Stack describes a Stack running on a Pulumi Cloud.
9 properties 6 required
AppPolicyGroupSummary
object
PolicyGroupSummary details the name, applicable stacks and the applied Policy Packs for an organization's Policy Group.
7 properties 6 required
AppBatchDecryptRequest
object
BatchDecryptRequest defines the request body for batch decrypting secret values.
1 property 1 required
AppDecryptValueResponse
object
DecryptValueResponse defines the response body for a decrypted value.
1 property 1 required
AppEngineEventBatch
object
EngineEventBatch is a group of engine events.
1 property 1 required
Team
object
Team describes a Pulumi team. A Pulumi team may have its organization managed by another service, such as GitHub.
11 properties 4 required
AppImportStackResponse
object
ImportStackResponse defines the response body for importing a Stack.
1 property 1 required
AppPolicyAnalyzeSummaryEvent
object
PolicyAnalyzeSummaryEvent is emitted after a call to Analyze on an analyzer, summarizing the results.
6 properties 4 required
AppImportStackRequest
object
ImportStackRequest defines the request body for importing a Stack.
3 properties
AppOperationV2
object
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…
2 properties 2 required
EngineEvent
object
EngineEvent expands apitype.EngineEvent, adding a little more metadata.
19 properties 2 required
AppBatchEncryptRequest
object
BatchEncryptRequest defines the request body for encrypting multiple values.
1 property 1 required
UpdateStackNotificationSettingsRequest
object
UpdateStackNotificationsRequest is the request object to adjust a stack's notification settings.
2 properties 2 required
StackTeam
object
StackTeam is a team that has access to a particular stack.
5 properties 5 required
StepRun
object
StepRun contains information about a step run.
4 properties 2 required
AppPolicyRemediationEvent
object
PolicyRemediationEvent is emitted whenever there is Policy transformation.
8 properties 5 required
AppUpdateOptions
object
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 t…
9 properties 9 required
AppMessage
object
Message is a message from the backend to be displayed to the user.
2 properties 1 required
DeploymentConfiguration
object
DeploymentConfiguration contains the configuration for a deployment, including environment variables and source settings.
2 properties 1 required
ListDownstreamStackReferencesResponse
object
ListDownstreamStackReferencesResponse is the response to list downstream references of a particular stack.
1 property 1 required
AppUpdateInfo
object
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 break…
11 properties 8 required
AppStartDebuggingEvent
object
StartDebuggingEvent is emitted to start a debugging session.
1 property
TeamStackPermission
object
TeamStackPermission is the permission team membership grants to a stack.
4 properties 3 required
AppGetStackPolicyPacksResponse
object
GetStackPolicyPacksResponse is the response to getting the applicable Policy Packs for a particular stack. This allows the CLI to download the packs prior to s…
1 property
AppJournalEntry
object
Represents app journal entry.
15 properties 6 required
StackNotificationSettings
object
StackNotificationSettings is the object containing the notification settings for a stack.
2 properties 2 required
AppUntypedDeployment
object
UntypedDeployment contains an inner, untyped deployment structure.
3 properties
GetDeploymentResponse
object
GetDeploymentResponse is the response from the API when getting a single Deployment.
11 properties 7 required
DeploymentWithRelatedUpdates
Activity
object
Represents activity.
2 properties
AppStackFrameV1
object
StackFrameV1 captures information about a stack frame.
1 property
TeamEnvironmentSettings
object
TeamEnvironmentSettings contains additional settings a team applies to an environment.
5 properties 3 required
AppSnapshotIntegrityErrorMetadataV1
object
SnapshotIntegrityErrorMetadataV1 contains metadata about a snapshot integrity error, such as the version and invocation of the Pulumi engine that caused it.
4 properties
Webhook
object
Webhook describes a webhook registered with the Pulumi Service. It may be registered to either an Organization, Stack or Environment.
12 properties 5 required
AppPropertyDiff
object
PropertyDiff describes the difference between a single property's old and new values.
2 properties 2 required
AppUpdateProgramRequest
object
UpdateProgramRequest is the request type for updating (aka deploying) a Pulumi program.
7 properties 7 required
GetUpdateTimelineResponse
object
GetUpdateTimelineResponse is the response type returning the timeline for a given update.
4 properties 3 required
AppLog3rdPartyDecryptionEvent
object
Log3rdPartyDecryptionEvent defines the request body for logging a 3rd party secrets provider decryption event.
2 properties
AppResOutputsEvent
object
ResOutputsEvent is emitted when a resource is finished being provisioned.
2 properties 1 required
GitHubCommitInfo
object
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…
6 properties
DeploymentJob
object
DeploymentJob represents a deployment job with its status, timing, and step information.
4 properties 2 required
AppStepEventStateMetadata
object
StepEventStateMetadata is the more detailed state information for a resource as it relates to a step(s) being performed.
15 properties 7 required
GetStackStarterWorkflowResponse
object
Response body for retrieving a starter workflow for a stack.
1 property 1 required
AppBatchEncryptResponse
object
BatchEncryptResponse defines the response body for multiple encrypted values.
1 property 1 required
AppProgressEvent
object
ProgressEvent is emitted when a potentially long-running engine process is in progress.
6 properties 6 required
AppUpdateResults
object
UpdateResults returns a series of events and the current status of an update. The events can be filtered. See API call for more details.
3 properties 2 required
AppResCustomTimeouts
object
Custom timeout values (in seconds) for resource CRUD operations.
3 properties
StackReference
object
StackReference contains information about a stack reference.
4 properties 4 required
StackOverviewResponse
object
StackOverviewResponse contains data to be displayed for the stack overview.
3 properties 3 required
UpdateTeamStackPermissionsRequest
object
UpdateTeamStackPermissionsRequest modifies the relationship between a stack and a team. (The stack-centric version of UpdateTeamRequest.)
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pulumi-stacks-api-openapi.yml Raw ↑

Other APIs Pulumi publishes across the network.

Pulumi Automation API
Pulumi AccessTokens API
Pulumi AI Agents API
Pulumi AI API
Pulumi AuditLogs API
Pulumi CloudSetup API
Pulumi DataExport API
Pulumi DeploymentRunners API
Pulumi Deployments API
Pulumi Environments API
Pulumi Insights API
Pulumi InsightsAccounts API
Where this information came from

This is an independent, third-party profile of Pulumi Stacks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.