The identity and technical contract details declared by the specification.
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
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
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Pulumi publishes across the network.