api library

Classes

Account
Creates a new Insights account. An Insights account represents a cloud provider account (e.g., AWS, Azure, OCI) configured for resource discovery.
AccountArgs
The set of arguments for Account. The set of arguments for Account.
AuditLogExportConfiguration
Creates or updates the organization's automated audit log export configuration. Audit log export enables automatic delivery of audit events to an S3 bucket for long-term retention and SIEM integration. The configuration includes the S3 bucket details and IAM role for authentication. This feature is available on Business Critical edition.
AuditLogExportConfigurationArgs
The set of arguments for AuditLogExportConfiguration. The set of arguments for AuditLogExportConfiguration.
AzureDevOpsIntegration
Updates an existing Azure DevOps integration's settings. Can modify the Azure DevOps organization, project, or authentication configuration.
AzureDevOpsIntegrationArgs
The set of arguments for AzureDevOpsIntegration. The set of arguments for AzureDevOpsIntegration.
BitBucketIntegration
Updates an existing BitBucket integration's settings, such as PR comment preferences and AI summary options.
BitBucketIntegrationArgs
The set of arguments for BitBucketIntegration. The set of arguments for BitBucketIntegration.
Config
Updates the service-managed configuration for a stack. The request body sets the ESC environment reference that points the stack at a service-backed configuration. 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. The 'secretsProvider', 'encryptedKey', and 'encryptionSalt' fields are deprecated; new callers should omit them.
ConfigArgs
The set of arguments for Config. The set of arguments for Config.
CustomVCSIntegration
Creates a new custom VCS integration for an organization. Custom VCS integrations allow connecting self-hosted or third-party version control systems (e.g. Gitea, Forgejo, Bitbucket Server) to Pulumi Deployments. Credentials are managed via ESC environments, and deployments are triggered by inbound webhooks. Returns the created integration including its webhook URL and HMAC secret for signature verification.
CustomVCSIntegrationArgs
The set of arguments for CustomVCSIntegration. The set of arguments for CustomVCSIntegration.
CustomVCSRepository
Adds a repository to a custom VCS integration. The repository name must be unique within the integration. Returns 409 Conflict if a repository with the same name is already configured.
CustomVCSRepositoryArgs
The set of arguments for CustomVCSRepository. The set of arguments for CustomVCSRepository.
DefaultOrganization
UpdateDefaultOrganization sets the default organization for the current user.
DefaultOrganizationArgs
The set of arguments for DefaultOrganization. The set of arguments for DefaultOrganization.
Environment
Creates a new Pulumi ESC (Environments, Secrets, and Configuration) environment within the specified organization. The request body must include the project name and the environment name. Environment names must be unique within a project and may only contain alphanumeric characters, hyphens, underscores, and periods. The newly created environment starts with an empty YAML definition that can be updated via the UpdateEnvironment endpoint.
EnvironmentArgs
The set of arguments for Environment. The set of arguments for Environment.
EnvironmentDraft
Creates a new draft change request for a Pulumi ESC environment. Drafts allow proposing changes to an environment definition that can be reviewed and approved before being applied. This is part of the approvals workflow for environments. Returns a ChangeRequestRef containing the draft identifier. Requires the Approvals feature to be enabled for the organization.
EnvironmentDraftArgs
The set of arguments for EnvironmentDraft. The set of arguments for EnvironmentDraft.
EnvironmentSchedule
Creates a new scheduled action for a Pulumi ESC environment. Schedules can be used to automate recurring operations on environments, such as secret rotation. The request body specifies the schedule timing and the action to perform. Returns the created ScheduledAction on success. Requires the secret rotation feature to be enabled for the organization.
EnvironmentScheduleArgs
The set of arguments for EnvironmentSchedule. The set of arguments for EnvironmentSchedule.
EnvironmentSettings
Updates settings for a Pulumi ESC environment using a partial update (patch) approach. Currently supports toggling deletion protection via the deletionProtected field. When deletionProtected is set to true, the environment cannot be deleted until the setting is explicitly disabled. Only the fields included in the request body are modified; omitted fields retain their current values.
EnvironmentSettingsArgs
The set of arguments for EnvironmentSettings. The set of arguments for EnvironmentSettings.
EnvironmentTag
Adds a new user-defined tag to a Pulumi ESC environment. Tags are key-value pairs that provide contextual metadata for organizing and searching environments (e.g., region=us-east-1, team=platform). The tag name and value are provided in the request body. Returns the created EnvironmentTag on success. Returns 409 if a tag with the same name already exists on the environment.
EnvironmentTagArgs
The set of arguments for EnvironmentTag. The set of arguments for EnvironmentTag.
Gate
Creates a new change gate for an entity in the organization. Change gates enforce approval workflows by requiring one or more approvals before infrastructure changes can be applied to the protected resource.
GateArgs
The set of arguments for Gate. The set of arguments for Gate.
GitHubEnterpriseIntegration
Updates GitHub Enterprise Server integration settings.
GitHubEnterpriseIntegrationArgs
The set of arguments for GitHubEnterpriseIntegration. The set of arguments for GitHubEnterpriseIntegration.
GitHubIntegration
Updates GitHub App integration settings.
GitHubIntegrationArgs
The set of arguments for GitHubIntegration. The set of arguments for GitHubIntegration.
GitLabIntegration
Updates an existing GitLab integration's settings, such as PR comment preferences and AI summary options.
GitLabIntegrationArgs
The set of arguments for GitLabIntegration. The set of arguments for GitLabIntegration.
Item
Adds items (such as access tokens, team memberships, or stack permissions) to an existing service account. Service accounts provide programmatic, non-human access to Pulumi Cloud resources and are scoped to an organization. Items define what the service account can access and what credentials it holds. Returns the updated service details.
ItemArgs
The set of arguments for Item. The set of arguments for Item.
OidcIssuer
Registers a new OIDC issuer for an organization, establishing a trust relationship with an external identity provider. Once registered, the identity provider can issue signed, short-lived tokens that are exchanged for temporary Pulumi Cloud credentials during deployments. This eliminates the need to store long-lived access tokens. Supported providers include AWS, Azure, Google Cloud, GitHub Actions, and any OIDC-compliant identity provider. The request must include the issuer URL, and the service will fetch the provider's public signing keys to verify token authenticity.
OidcIssuerArgs
The set of arguments for OidcIssuer. The set of arguments for OidcIssuer.
OpenEnvironmentRequest
Creates an open request for a Pulumi ESC environment that has gated opens enabled. When an environment has open gates configured, opening the environment requires an approval workflow. This endpoint initiates that process by creating an open request, and also creates corresponding open requests for each imported environment that has open gates. Requires the Approvals feature to be enabled for the organization. Returns 400 if the environment does not have gated opens.
OpenEnvironmentRequestArgs
The set of arguments for OpenEnvironmentRequest. The set of arguments for OpenEnvironmentRequest.
OrganizationMember
Adds an existing Pulumi user to an organization with a built-in role. Important: The user must have already signed up for a Pulumi account before they can be added to an organization.
OrganizationMemberArgs
The set of arguments for OrganizationMember. The set of arguments for OrganizationMember.
OrganizationWebhook
Creates a new webhook for an organization to notify external services when events occur. Webhooks can be configured to fire on stack events (created, deleted, update succeeded/failed), deployment events (queued, started, succeeded, failed), drift detection events, and policy violation events (mandatory, advisory).
OrganizationWebhookArgs
The set of arguments for OrganizationWebhook. The set of arguments for OrganizationWebhook.
OrgTemplateCollection
Creates a new template collection (source) for an organization. Template collections define where project templates are sourced from, such as a Git repository. Organization members can use these templates to create new stacks with pre-configured infrastructure code.
OrgTemplateCollectionArgs
The set of arguments for OrgTemplateCollection. The set of arguments for OrgTemplateCollection.
OrgToken
Generates a new access token scoped to the organization for use in CI/CD pipelines and automated workflows. Organization tokens belong to the organization rather than individual users, ensuring that access is not disrupted when team members leave.
OrgTokenArgs
The set of arguments for OrgToken. The set of arguments for OrgToken.
PersonalToken
Creates a new personal access token for the authenticated user. The request body includes a description for the token and an optional expiration time. The response includes the token ID and the tokenValue (prefixed with 'pul-'). The token value is only returned once at creation time and cannot be retrieved later.
PersonalTokenArgs
The set of arguments for PersonalToken. The set of arguments for PersonalToken.
Policy
Updates an authentication policy for an organization. Authentication policies define rules for how OIDC tokens are validated and what access they grant, including claim mappings, trust conditions, and role assignments. The policy definition cannot be empty.
PolicyArgs
The set of arguments for Policy. The set of arguments for Policy.
PolicyGroup
Creates a new Policy Group for an organization. Policy Groups define which Policy Packs are enforced on which stacks or cloud accounts, with configurable enforcement levels (advisory, mandatory, or disabled) per pack. This allows different policy strictness for different environments, such as advisory-only in development and mandatory in production.
PolicyGroupArgs
The set of arguments for PolicyGroup. The set of arguments for PolicyGroup.
PolicyGroupInsightsAccountAttachment
Manages a single membership edge through UpdatePolicyGroup (addInsightsAccount / removeInsightsAccount).
PolicyGroupInsightsAccountAttachmentArgs
The set of arguments for PolicyGroupInsightsAccountAttachment. The set of arguments for PolicyGroupInsightsAccountAttachment.
PolicyGroupStackAttachment
Manages a single membership edge through UpdatePolicyGroup (addStack / removeStack).
PolicyGroupStackAttachmentArgs
The set of arguments for PolicyGroupStackAttachment. The set of arguments for PolicyGroupStackAttachment.
Pool
Creates a new agent pool for an organization. Agent pools enable self-hosted deployment agents, allowing organizations to run Pulumi Deployments on their own infrastructure rather than Pulumi-managed infrastructure. This is useful for accessing private networks, meeting compliance requirements, or using custom execution environments. The response includes an access token (agent pool secret) that self-hosted agents use to authenticate when polling for deployment work. This token is only returned once at creation time and cannot be retrieved later.
PoolArgs
The set of arguments for Pool. The set of arguments for Pool.
RevisionTag
Creates a new revision tag for a Pulumi ESC environment. Revision tags are named references that point to specific revision numbers, similar to Git tags. They allow pinning a stable reference to a known-good version of an environment. Tagged versions can be used in imports and Pulumi stack configuration (e.g., myproject/env@prod) to ensure stable references unaffected by subsequent changes. The built-in 'latest' tag always points to the most recent revision.
RevisionTagArgs
The set of arguments for RevisionTag. The set of arguments for RevisionTag.
Role
UpdateTeamRoles upserts the role assigned to a team since we currently only support a 1:1 mapping of teams to roles.
RoleApi
Creates a new custom role for an organization. Custom roles define fine-grained permission sets that can be assigned to organization members and teams, enabling precise access control beyond the built-in admin and member roles. Optionally, an associated policy and role binding can be created alongside the role. Role definitions are subject to two limits: a permission descriptor group may contain at most 500 entries (each directly-specified entity counts as one entry), and the total serialized size of the role definition may not exceed 1 MB. Exceeding either limit returns a 400 error. If you need to grant access to more than 500 individually listed resources, use tag-based (ABAC) rules instead.
RoleApiArgs
The set of arguments for Role. The set of arguments for Role.
RoleArgs
The set of arguments for Role. The set of arguments for Role.
SAML
Updates the SAML configuration for a SAML-backed organization, including the identity provider SSO descriptor, attribute mappings, and other SAML settings. The new IDP SSO descriptor is required in the update request.
SAMLArgs
The set of arguments for SAML. The set of arguments for SAML.
ScheduledDeployment
Creates a custom deployment schedule for a stack using Pulumi Deployments. Custom schedules allow you to automate recurring or one-time Pulumi operations on a stack. The request must include exactly one of 'scheduleCron' (a cron expression for recurring executions, e.g. '0 */4 * * *' for every 4 hours) or 'scheduleOnce' (an ISO 8601 timestamp for a one-time execution). The 'request' field contains the deployment configuration that will be executed on each scheduled run, including the Pulumi operation type and any settings overrides. The stack must have deployment settings configured before a schedule can be created.
ScheduledDeploymentArgs
The set of arguments for ScheduledDeployment. The set of arguments for ScheduledDeployment.
ScheduledScanSettings
Updates the scheduled scan configuration for an Insights account, such as scan frequency and schedule.
ScheduledScanSettingsArgs
The set of arguments for ScheduledScanSettings. The set of arguments for ScheduledScanSettings.
Service
Creates a new service account in an organization. Service accounts provide programmatic, non-human identities for accessing Pulumi Cloud resources. They are scoped to an organization and can hold access tokens, belong to teams, and have stack permissions. The service name must be unique within the organization.
ServiceArgs
The set of arguments for Service. The set of arguments for Service.
Settings
Creates or updates Pulumi Deployments settings for a stack using a merge operation. If no settings exist, they are created. If settings already exist, the request body is merged with the current settings using the following logic: for each property, start with the current value, remove it if the patch specifies null, or merge the new non-null value with the existing one. Non-object properties (strings, numbers, booleans) are replaced entirely. Settings include source context (git repository URL, branch, directory), operation context (environment variables, pre-run commands, OIDC configuration), executor context, GitHub integration settings, and cache options. Requires a Team Growth or higher subscription. Cannot be used to configure Pulumi Deployments for Terraform stacks.
SettingsArgs
The set of arguments for Settings. The set of arguments for Settings.
Stack
Creates a new stack within a project in the organization. If the project does not exist, it will be created. A stack is an isolated, independently configurable instance of a Pulumi program, typically representing a deployment environment (e.g., development, staging, production). The stack name must be unique within the project.
StackArgs
The set of arguments for Stack. The set of arguments for Stack.
Tag
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.
TagArgs
The set of arguments for Tag. The set of arguments for Tag.
Task
Creates a new agent task for the specified organization. The request must include a prompt (the user event message) that initiates the task. Set the 'permissionMode' field in the request body to restrict the agent to read-only operations. Returns the created task details including task ID, name, status, and timestamp.
TaskArgs
The set of arguments for Task. The set of arguments for Task.
Team
CreatePulumiTeam creates a "Pulumi" team, i.e. one whose membership is managed by Pulumi. (As opposed to a GitHub or GitLab-based team.)
TeamArgs
The set of arguments for Team. The set of arguments for Team.
TeamToken
Generates a new access token scoped to a specific team within an organization. Team tokens inherit the stack permissions assigned to the team, making them suitable for CI/CD pipelines that need access limited to a specific set of stacks.
TeamTokenArgs
The set of arguments for TeamToken. The set of arguments for TeamToken.
Webhook
Creates a new webhook for a Pulumi ESC environment. Webhooks allow external services to be notified when environment events occur, such as updates or opens. The request body specifies the webhook configuration including the destination URL, event filters, and format. Returns 400 if the organization name in the request body does not match the URL path parameter. Returns 409 if a webhook with the same name already exists.
WebhookApiStacks
Creates a new webhook for the specified stack. The request body must include the webhook name, payload URL, and format.
WebhookApiStacksArgs
The set of arguments for Webhook. The set of arguments for Webhook.
WebhookArgs
The set of arguments for Webhook. The set of arguments for Webhook.