{ "opencollection": "1.0.0", "info": { "name": "Pulumi APIs", "version": "1.0.0" }, "items": [ { "info": { "name": "AI", "type": "folder" }, "items": [ { "info": { "name": "AITemplate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/ai/template", "body": { "type": "json", "data": "{}" } }, "docs": "Generates a Pulumi template using the Pulumi AI service." } ] }, { "info": { "name": "Miscellaneous", "type": "folder" }, "items": [ { "info": { "name": "Capabilities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/capabilities" }, "docs": "Returns the set of capabilities that the service supports." }, { "info": { "name": "Version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/cli/version" }, "docs": "Returns version information about the CLI." }, { "info": { "name": "Token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/oauth/token", "body": { "type": "json", "data": "{}" } }, "docs": "Exchanges an external identity provider token for a Pulumi access token using the OAuth 2.0 Token Exchange flow (RFC 8693).\n\nThe request body must include:\n- `audience`: a URN identifying the target org (e.g., `urn:pulumi:org:{ORG_NAME}`)\n- `grant_type`: must be `urn:ietf:params:oauth:grant-type:token-exchange`\n- `subject_token`: the OIDC identity token from the external provider\n- `subject_token_type`: must be `urn:ietf:params:oauth:token-type:id_token`\n- `requested_token_type`: one of `urn:pul" }, { "info": { "name": "FetchRestSpecification", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/openapi/pulumi-spec.json" }, "docs": "Returns the OpenAPI v3 specification for the service." } ] }, { "info": { "name": "Organizations", "type": "folder" }, "items": [ { "info": { "name": "ListChangeGates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/change-gates/:orgName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "entityType", "value": "", "type": "query", "description": "The entity type to filter by" }, { "name": "qualifiedName", "value": "", "type": "query", "description": "The fully qualified entity name" } ] }, "docs": "Lists change gates for an entity within the organization. Change gates define approval requirements that must be satisfied before changes can be applied to infrastructure resources. Currently supports listing gates for a single entity specified by entityType and qualifiedName query parameters." }, { "info": { "name": "CreateChangeGate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/change-gates/:orgName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "ReadChangeGate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/change-gates/:orgName/:gateID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "gateID", "value": "", "type": "path", "description": "The change gate identifier" } ] }, "docs": "Retrieves the configuration and status of a specific change gate, including its approval requirements and the entity it protects." }, { "info": { "name": "UpdateChangeGate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/change-gates/:orgName/:gateID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "gateID", "value": "", "type": "path", "description": "The change gate identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of an existing change gate, such as modifying its approval requirements or protected entity." }, { "info": { "name": "DeleteChangeGate", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/change-gates/:orgName/:gateID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "gateID", "value": "", "type": "path", "description": "The change gate identifier" } ] }, "docs": "Deletes a change gate, removing the approval requirement from the protected entity. Changes to the entity will no longer require approval." }, { "info": { "name": "ListChangeRequests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/change-requests/:orgName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "count", "value": "", "type": "query", "description": "Number of items to return" }, { "name": "entityId", "value": "", "type": "query", "description": "The entity identifier to filter by" }, { "name": "entityType", "value": "", "type": "query", "description": "The entity type to filter by" } ] }, "docs": "Lists change requests for an organization with support for pagination and filtering by entity type and entity ID. Change requests represent proposed infrastructure modifications that require approval before being applied." }, { "info": { "name": "ReadChangeRequest", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/change-requests/:orgName/:changeRequestID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request identifier" } ] }, "docs": "Retrieves the details of a specific change request, including its current status, description, approvals, and the proposed infrastructure changes." }, { "info": { "name": "UpdateChangeRequest", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/change-requests/:orgName/:changeRequestID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a change request's metadata. Currently only the description field can be modified after creation." }, { "info": { "name": "ApplyChangeRequest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/change-requests/:orgName/:changeRequestID/apply", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request identifier" } ] }, "docs": "Applies an approved change request, triggering the execution of the proposed infrastructure changes. The change request must have received the required number of approvals before it can be applied. Returns 409 if there is a conflict preventing application." }, { "info": { "name": "ApproveChangeRequest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/change-requests/:orgName/:changeRequestID/approve", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Records an approval for a change request from the authenticated user. Once the required number of approvals is met, the change request can be applied." }, { "info": { "name": "UnapproveChangeRequest", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/change-requests/:orgName/:changeRequestID/approve", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Withdraws a previously given approval for a change request. If the change request no longer has the required number of approvals after withdrawal, it cannot be applied until additional approvals are granted." }, { "info": { "name": "CloseChangeRequest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/change-requests/:orgName/:changeRequestID/close", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Closes a change request without applying it. The proposed infrastructure changes are discarded and the request is marked as closed." }, { "info": { "name": "AddChangeRequestComment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/change-requests/:orgName/:changeRequestID/comments", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a comment to a change request without approving or closing it. This allows reviewers to provide feedback or ask questions before making a decision." }, { "info": { "name": "ListChangeRequestEvents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/change-requests/:orgName/:changeRequestID/events", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request identifier" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" } ] }, "docs": "Lists the event log for a change request, including approvals, status changes, and other lifecycle events. Supports pagination via continuation token." }, { "info": { "name": "SubmitChangeRequest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/change-requests/:orgName/:changeRequestID/submit", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submits a draft change request for approval. Once submitted, the request enters the review workflow and requires the configured number of approvals before it can be applied." }, { "info": { "name": "GetOrganization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns detailed information about the specified organization, including its name, display name, avatar URL, enabled features, subscription tier, and access control settings. The response includes member count, team availability, and other configuration relevant to the caller's role within the organization." }, { "info": { "name": "UpdateOrganizationSettings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an organization's settings, such as the default stack permission level for new members, whether members can create teams, and other organization-wide configuration options. Returns the updated organization metadata." }, { "info": { "name": "ListAuditLogEventsHandlerV1", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/auditlogs", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Token for paginated result retrieval" }, { "name": "endTime", "value": "", "type": "query", "description": "Upper bound of the query range (unix timestamp)" }, { "name": "eventFilter", "value": "", "type": "query", "description": "Filter audit logs by event type" }, { "name": "format", "value": "", "type": "query", "description": "Response format: 'json' (default)" }, { "name": "startTime", "value": "", "type": "query", "description": "Returns entries older than this timestamp (unix timestamp)" }, { "name": "userFilter", "value": "", "type": "query", "description": "Filter audit logs by username" } ] }, "docs": "Lists audit log events for an organization. Either continuationToken or startTime is required. Supports filtering by event type and user." }, { "info": { "name": "ExportAuditLogEventsHandlerV1", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/auditlogs/export", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Token for paginated result retrieval" }, { "name": "endTime", "value": "", "type": "query", "description": "Upper bound of the query range (unix timestamp)" }, { "name": "eventFilter", "value": "", "type": "query", "description": "Filter audit logs by event type" }, { "name": "format", "value": "", "type": "query", "description": "Response format: 'cef' or 'csv' (defaults to csv)" }, { "name": "startTime", "value": "", "type": "query", "description": "Returns entries older than this timestamp (unix timestamp)" }, { "name": "userFilter", "value": "", "type": "query", "description": "Filter audit logs by username" } ] }, "docs": "Exports audit log events for an organization in a downloadable format. Audit logs provide an immutable record of all user activity within the organization, including stack operations, member changes, and policy modifications. Results can be filtered by time range, event type, and user. Supported export formats are CSV and CEF (Common Event Format for SIEM integration). Pagination is supported via the continuationToken parameter.\n\n**Important:** This endpoint differs from other API endpoints:\n- T" }, { "info": { "name": "GetAuditLogExportConfiguration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/auditlogs/export/config", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "GetAuditLogExportConfiguration returns the organization's current audit log export configuration.\nIf the organization has not configured its audit logs for export, returns a 404." }, { "info": { "name": "UpdateAuditLogExportConfiguration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/auditlogs/export/config", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "DeleteAuditLogExportConfiguration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/auditlogs/export/config", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "DeleteAuditLogExportConfiguration removes an organization's audit log export settings.\nSkip feature validation so removal can happen if org no longer has access to feature." }, { "info": { "name": "ForceAuditLogExport", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/auditlogs/export/config/force", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "timestamp", "value": "", "type": "query", "description": "Unix timestamp to export audit logs for (used for backfilling missed data)" } ] }, "docs": "ForceAuditLogExport exports the audit logs for the organization for a user-supplied timestamp.\nThis can be used to backfill data that may have been missed due to an outage or permissions issue." }, { "info": { "name": "TestAuditLogExportConfiguration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/auditlogs/export/config/test", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "TestAuditLogExportConfiguration uses the provided audit log configuration and\nchecks if we are able to successfully write some data." }, { "info": { "name": "GetAuditLogsReaderKind", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/auditlogs/reader-kind", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "GetAuditLogsReaderKind returns whether the audit log is being read\nfrom MySQL or DynamoDB to control the event filtering UI on the front end." }, { "info": { "name": "ListAuditLogEventsHandlerV2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/auditlogs/v2", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Token for paginated result retrieval" }, { "name": "endTime", "value": "", "type": "query", "description": "Upper bound of the query range (unix timestamp)" }, { "name": "eventFilter", "value": "", "type": "query", "description": "Filter audit logs by event type" }, { "name": "format", "value": "", "type": "query", "description": "Response format: 'json' (default)" }, { "name": "startTime", "value": "", "type": "query", "description": "Lower bound of the query range (unix timestamp)" }, { "name": "userFilter", "value": "", "type": "query", "description": "Filter audit logs by username" } ] }, "docs": "Lists audit log events for an organization. Uses startTime as the lower bound and endTime as the upper bound of the query range. Supports filtering by event type and user." }, { "info": { "name": "ExportAuditLogEventsHandlerV2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/auditlogs/v2/export", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Token for paginated result retrieval" }, { "name": "endTime", "value": "", "type": "query", "description": "Upper bound of the query range (unix timestamp)" }, { "name": "eventFilter", "value": "", "type": "query", "description": "Filter audit logs by event type" }, { "name": "format", "value": "", "type": "query", "description": "Response format: 'cef' or 'csv' (defaults to csv)" }, { "name": "startTime", "value": "", "type": "query", "description": "Lower bound of the query range (unix timestamp)" }, { "name": "userFilter", "value": "", "type": "query", "description": "Filter audit logs by username" } ] }, "docs": "Exports audit log events in a downloadable format (CSV or CEF). Supports filtering by time range using startTime (lower bound) and endTime (upper bound), as well as filtering by event type and user." }, { "info": { "name": "GetAuthPolicy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/auth/policies/oidcissuers/:issuerId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "issuerId", "value": "", "type": "path", "description": "The OIDC issuer identifier" } ] }, "docs": "Returns the authentication policy associated with a specific OIDC issuer registration. Authentication policies define rules for how OIDC tokens from the issuer are validated and what access they grant, including claim mappings and trust conditions." }, { "info": { "name": "UpdateAuthPolicy", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName/auth/policies/:policyId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "policyId", "value": "", "type": "path", "description": "The policy identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\nThe request body contains a `policies` array where each policy object includes:\n- `decision`: `allow` or `deny`\n- `tokenType`: `organization`, `team`, `personal`, or `runner`\n- `teamName`: required when tokenType is `team`\n- `userLogin`: req" }, { "info": { "name": "TransferAllStacks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/bulk-transfer/stacks", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "TransferAllStacks transfers all active stacks from one org to another, where deleted stacks\nwill be skipped/ignored. We are currently constraining usage of this function to organizations\nwith less than or equal to TransferAllStacksMax stacks.\n\nNOTE: This operation will lock the organization while the transfer is in-progress, to\nrewrite all checkpoint files that use service-managed secrets. This means that the\norganization will be read-only and no stack updates can begin until the rename process\n" }, { "info": { "name": "ListOrganizationKeys", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/cmk", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns all customer managed keys (CMK) configured for an organization, including their key identifiers, cloud provider details, enabled status, and which key is set as the default for new stacks." }, { "info": { "name": "CreateOrganizationKey", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/cmk", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new customer managed key (CMK) for an organization, allowing the organization to use their own encryption keys for securing secrets stored in Pulumi Cloud. The key must be a valid cloud provider key (e.g., AWS KMS). Once created, the key can be set as the default encryption key for all new stacks in the organization." }, { "info": { "name": "DisableAllOrganizationKeys", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/cmk/disable", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Disables all customer managed keys (CMK) for an organization, reverting to Pulumi-managed encryption for secrets. After disabling, new stacks will use the default Pulumi-managed encryption rather than customer-provided keys." }, { "info": { "name": "ListOrganizationKeyMigrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/cmk/migration", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns all key encryption key (KEK) migrations for an organization. KEK migrations track the process of re-encrypting secrets when rotating customer managed keys. Each migration record includes the source and destination keys, status, and any errors encountered during the migration process." }, { "info": { "name": "RetryOrganizationKeyMigrations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/cmk/migration/retry", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Retries any failed key encryption key (KEK) migrations for an organization. KEK migrations can fail due to transient errors when re-encrypting secrets during customer managed key rotation. This endpoint re-attempts the failed migrations without restarting the entire process." }, { "info": { "name": "SetDefaultOrganizationKey", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/cmk/:keyID/default", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "keyID", "value": "", "type": "path", "description": "The key identifier" } ] }, "docs": "Sets a customer managed key as the default encryption key for the organization. New stacks created in the organization will use this key for encrypting secrets by default. The key must already be created and enabled for the organization." }, { "info": { "name": "DisableOrganizationKey", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/cmk/:keyID/disable", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "keyID", "value": "", "type": "path", "description": "The key identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disables a specific customer managed key (CMK) for an organization. The key can no longer be used for encrypting new secrets, but existing secrets encrypted with this key remain accessible." }, { "info": { "name": "GetUsageSummaryDiscoveredResourceHours", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/discovered-resources/summary", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "granularity", "value": "", "type": "query", "description": "Time granularity for aggregation (e.g., 'hourly', 'daily', 'monthly')" }, { "name": "lookbackDays", "value": "", "type": "query", "description": "Number of days to look back from the current time or lookbackStart" }, { "name": "lookbackStart", "value": "", "type": "query", "description": "Unix timestamp for the start of the lookback period (defaults to current time if omitted)" } ] }, "docs": "GetUsageSummaryDiscoveredResourceHours handles request to fetch the summary\nof discovered resources for an organization." }, { "info": { "name": "ListOrganizationWebhooks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/hooks", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns all webhooks configured at the organization level. Each webhook in the response includes its name, destination URL, format (generic JSON, Slack, or Microsoft Teams), active status, and subscribed event filters. Organization-level webhooks can fire on stack lifecycle events, deployment events, drift detection events, and policy violation events." }, { "info": { "name": "CreateOrganizationWebhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/hooks", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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).\n\nThe `format` field accepts: `raw` (default), `slack`, `ms_teams`, or `pulumi_deployments`.\n\nThe `filters` field accepts a list of event types to subscribe to. See the [webhook event f" }, { "info": { "name": "GetOrganizationWebhook", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/hooks/:hookName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name identifier" } ] }, "docs": "Returns the configuration of a specific organization-level webhook, including its name, destination URL, format (generic JSON, Slack, or Microsoft Teams), active status, event filter subscriptions, and whether a shared secret is configured for HMAC signature verification." }, { "info": { "name": "UpdateOrganizationWebhook", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName/hooks/:hookName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing organization-level webhook's configuration, including its destination URL, format, active status, event filter subscriptions, and shared secret. The 'pulumi_deployments' format can only be used on stack or environment webhooks, not organization-level ones." }, { "info": { "name": "DeleteOrganizationWebhook", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/hooks/:hookName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name identifier" } ] }, "docs": "Permanently deletes an organization-level webhook. The webhook will no longer receive event notifications for stack updates, deployments, drift detection, or policy violations. This action cannot be undone." }, { "info": { "name": "GetOrganizationWebhookDeliveries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/hooks/:hookName/deliveries", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name identifier" } ] }, "docs": "Returns the recent delivery history for a specific webhook, including the HTTP status code, response time, request payload, and delivery timestamp for each attempt. This allows monitoring webhook health and diagnosing delivery failures. Each delivery includes a unique Pulumi-Webhook-ID." }, { "info": { "name": "RedeliverOrganizationWebhookEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/hooks/:hookName/deliveries/:event/redeliver", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name identifier" }, { "name": "event", "value": "", "type": "path", "description": "The event identifier to redeliver" } ] }, "docs": "Triggers the Pulumi Service to redeliver\na specific event to a webhook. For example, to resend an event that the\nhook failed to process the first time." }, { "info": { "name": "PingOrganizationWebhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/hooks/:hookName/ping", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name identifier" } ] }, "docs": "Sends a test ping to an organization webhook to validate that it is working.\nThis function bypasses the message queue machinery and issues the request directly to the webhook." }, { "info": { "name": "ListOrganizationMembers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/members", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Token for paginated result retrieval" }, { "name": "type", "value": "", "type": "query", "description": "Member type to list: 'frontend' for Pulumi Service members or 'backend' for organization backend members" } ] }, "docs": "ListOrganizationMembers lists the members of an organization. This API unfortunately has two different\n\"modes\", returning either the organization's \"frontend members\" or \"backend members\".\n\n - A \"frontend member\" is data stored in the Pulumi Service's database. For organizations billed\n per-member, this is the set of members that are counted against the organization's seat cap.\n - A \"backend member\" is data stored in the organization's backend. (e.g. GitHub, GitLab, or for SAML\n orgs, al" }, { "info": { "name": "AddOrganizationMember", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/members/:userLogin", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "userLogin", "value": "", "type": "path", "description": "The user login name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\nThis endpoint only assigns built-in roles. To onboard a user with a custom role, use the organization invite flow (`BatchCreateOrgInviteEmail`) and set `roleId` on the invite — the custom role is applied when the user accepts. Alternatively, add the user here with a built-in role and then call `UpdateOrganizat" }, { "info": { "name": "UpdateOrganizationMember", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName/members/:userLogin", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "userLogin", "value": "", "type": "path", "description": "The user login name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a user's role within an organization. Set `role` to assign a built-in role (`member`, `admin`, or `billingManager`), or set `fgaRoleId` to assign a custom role. If both are provided, `fgaRoleId` takes precedence." }, { "info": { "name": "DeleteOrganizationMember", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/members/:userLogin", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "userLogin", "value": "", "type": "path", "description": "The user login name" } ] }, "docs": "Removes a user from an organization. The removed user loses access to all organization resources including stacks, teams, and projects. The caller cannot remove themselves from the organization. The user is also removed from all teams they belong to within the organization." }, { "info": { "name": "SetSoleOrganizationAdmin", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/members/:userLogin/set-admin", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "userLogin", "value": "", "type": "path", "description": "The user login name" } ] }, "docs": "Promotes a member to administrator on organizations that are limited to a single admin. This endpoint is only valid for Team subscriptions (Team Starter and Team Growth) — it returns 400 on any other plan. On these plans, `UpdateOrganizationMember` cannot promote a member to admin, because doing so would require simultaneously demoting the current admin. This endpoint performs both changes atomically: the caller (who must be the current sole admin) is demoted to member and the target user is pro" }, { "info": { "name": "GetOrganizationMetadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/metadata", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "GetOrganizationMetadata returns metadata about the given organization. This is\ndesigned to be an inexpensive call." }, { "info": { "name": "List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/oidc/issuers", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns all OIDC issuer registrations for an organization. OIDC issuer registrations establish trust relationships with external identity providers (such as AWS, Azure, Google Cloud, or GitHub Actions) to enable token exchange for temporary Pulumi Cloud credentials. This eliminates the need for long-lived access tokens in CI/CD pipelines and deployment automation." }, { "info": { "name": "RegisterOidcIssuer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/oidc/issuers", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 servic" }, { "info": { "name": "GetOidcIssuer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/oidc/issuers/:issuerId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "issuerId", "value": "", "type": "path", "description": "The OIDC issuer identifier" } ] }, "docs": "Returns the details of a specific OIDC issuer registration, including the issuer URL, audience restrictions, TLS thumbprints, and trust policy configuration. OIDC issuer registrations establish trust relationships between the organization and external identity providers, enabling token exchange for temporary Pulumi Cloud credentials without storing long-lived secrets." }, { "info": { "name": "UpdateOidcIssuer", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName/oidc/issuers/:issuerId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "issuerId", "value": "", "type": "path", "description": "The OIDC issuer identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing OIDC issuer registration for an organization. This can be used to modify the issuer name, audience restrictions, trust policies, or other configuration. The issuer URL itself cannot be changed after creation. The issuer name is required in the update request." }, { "info": { "name": "DeleteOidcIssuer", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/oidc/issuers/:issuerId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "issuerId", "value": "", "type": "path", "description": "The OIDC issuer identifier" } ] }, "docs": "Deletes an OIDC issuer registration from an organization, removing the trust relationship between the organization and the identity provider. After deletion, tokens issued by this provider can no longer be exchanged for temporary Pulumi Cloud credentials. Any deployments or automation relying on this OIDC issuer for authentication will stop working." }, { "info": { "name": "RegenerateThumbprints", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/oidc/issuers/:issuerId/regenerate-thumbprints", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "issuerId", "value": "", "type": "path", "description": "The OIDC issuer identifier" } ] }, "docs": "Regenerates the TLS certificate thumbprints for an OIDC issuer by re-fetching the issuer's public keys. This is needed when the identity provider rotates its TLS certificates. Cannot be used if the issuer's JWKS are statically configured." }, { "info": { "name": "GetPackageUsedByStacks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/packages/usage", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "The continuation token" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return per page. Defaults to 100, maximum 500." }, { "name": "packageName", "value": "", "type": "query", "description": "The package name" }, { "name": "version", "value": "", "type": "query", "description": "Filter to stacks using this specific version. If omitted, returns stacks using any version." } ] }, "docs": "Returns the stacks within an organization that use a specific Pulumi package, helping track package adoption and identify affected stacks when planning package upgrades or deprecations." }, { "info": { "name": "ListPolicyGroups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/policygroups", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns a list of all Policy Groups for the organization. Policy Groups define which Policy Packs are enforced on which stacks, with configurable enforcement levels (advisory, mandatory, or disabled) per pack. Every organization has a default Policy Group, and additional groups can be created to apply different policy sets to different environments (e.g., stricter enforcement in production)." }, { "info": { "name": "NewPolicyGroup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/policygroups", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetPolicyGroupMetadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/policygroups/metadata", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns high-level policy protection metrics for an organization, including the number of stacks protected by policy enforcement, the total number of Policy Groups, and overall policy coverage statistics." }, { "info": { "name": "GetPolicyGroup", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/policygroups/:policyGroup", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "policyGroup", "value": "", "type": "path", "description": "The policy group name" } ] }, "docs": "Returns the details of a specific Policy Group, including the list of Policy Packs applied to it and their enforcement levels (advisory, mandatory, or disabled), as well as the stacks or cloud accounts assigned to the group. Policy Groups enable targeted policy enforcement by associating sets of policies with specific infrastructure resources." }, { "info": { "name": "UpdatePolicyGroup", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName/policygroups/:policyGroup", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "policyGroup", "value": "", "type": "path", "description": "The policy group name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Policy Group's configuration. This multi-purpose endpoint supports several operations in a single request via different body fields:\n\n- `newName`: rename the policy group\n- `addStack` / `removeStack`: add or remove stacks (with `name` and `routingProject` fields)\n- `addPolicyPack` / `removePolicyPack`: add or remove policy packs (with `name`, `version`, `versionTag`, and optional `config`)\n- `addInsightsAccount` / `removeInsightsAccount`: add or remove Insights accounts\n\nEnforcement le" }, { "info": { "name": "DeletePolicyGroup", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/policygroups/:policyGroup", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "policyGroup", "value": "", "type": "path", "description": "The policy group name" } ] }, "docs": "Deletes a Policy Group from an organization. A Policy Group defines which Policy Packs are enforced on which stacks, with configurable enforcement levels (advisory, mandatory, or disabled) per pack. The organization's default Policy Group cannot be deleted. Deleting a Policy Group removes all policy enforcement associations for the stacks that were assigned to it." }, { "info": { "name": "BatchUpdatePolicyGroup", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName/policygroups/:policyGroup/batch", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "policyGroup", "value": "", "type": "path", "description": "The policy group name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "BatchUpdatePolicyGroup applies multiple update operations to the Policy Group efficiently. Each operation in the list uses the same fields as UpdatePolicyGroupRequest. Operations are grouped by type (adds, removes) and processed in batches for efficiency." }, { "info": { "name": "ListPolicyPacks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/policypacks", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "policypack", "value": "", "type": "query", "description": "The policy pack name" } ] }, "docs": "ListPolicyPacks returns a list of all complete Policy Packs for the organization.\nIf the `policypack` query parameter is set, it will only list the policy\npacks with the specified name." }, { "info": { "name": "CreatePolicyPack", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/policypacks", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Policy Pack for an organization. A Policy Pack is a versioned collection of related policies that validate infrastructure configuration during deployments. Policies can enforce rules such as requiring encryption on storage buckets or prohibiting public access to databases. The pack must contain at least one policy. Once created, the pack can be applied to Policy Groups to enforce rules on specific stacks with configurable enforcement levels (advisory, mandatory, or disabled)." }, { "info": { "name": "DeletePolicyPack", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/policypacks/:policyPackName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "policyPackName", "value": "", "type": "path", "description": "The policy pack name" } ] }, "docs": "DeletePolicyPack deletes all versions of a Policy Pack, the associated\npacks stored in S3, and any applied versions of the Policy Packs." }, { "info": { "name": "GetPolicyPack", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/policypacks/:policyPackName/versions/:version", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "policyPackName", "value": "", "type": "path", "description": "The policy pack name" }, { "name": "version", "value": "", "type": "path", "description": "The version number" } ] }, "docs": "Returns the metadata and list of individual policies for a specific version of a Policy Pack. Each policy includes its name, description, enforcement level (advisory, mandatory, or disabled), and configuration schema. Returns 400 if the Policy Pack version is not yet complete (still being uploaded), or 404 if the organization or pack is not found." }, { "info": { "name": "DeletePolicyPackVersion", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/policypacks/:policyPackName/versions/:version", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "policyPackName", "value": "", "type": "path", "description": "The policy pack name" }, { "name": "version", "value": "", "type": "path", "description": "The version number" } ] }, "docs": "DeletePolicyPackVersion deletes a specific version of a Policy Pack and deletes\nthe associated pack stored in S3. A Policy Pack must be unapplied to be deleted." }, { "info": { "name": "CompletePolicyPack", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/policypacks/:policyPackName/versions/:version/complete", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "policyPackName", "value": "", "type": "path", "description": "The policy pack name" }, { "name": "version", "value": "", "type": "path", "description": "The version number" } ] }, "docs": "Transitions the publish status of a specific Policy Pack version to 'complete', making it available for enforcement. Policy Packs go through a multi-step publish process: first the pack content is uploaded, then this endpoint is called to finalize publication. Returns 400 if the pack is already complete." }, { "info": { "name": "GetPolicyPackConfigSchema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/policypacks/:policyPackName/versions/:version/schema", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "policyPackName", "value": "", "type": "path", "description": "The policy pack name" }, { "name": "version", "value": "", "type": "path", "description": "The version number" } ] }, "docs": "Returns the JSON configuration schema for a specific version of a Policy Pack. The schema defines the configurable parameters for each policy in the pack, including allowed values, defaults, and validation rules. Policy Groups use this schema to configure policy behavior when assigning packs to stacks." }, { "info": { "name": "GetPolicyComplianceResults", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/policyresults/compliance", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns compliance results for policy issues grouped by entity. The grouping can be by stack, cloud account, or severity, providing different views of the organization's policy compliance posture. This powers the compliance dashboard in the Pulumi Cloud console." }, { "info": { "name": "ListPolicyIssues", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/policyresults/issues", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns all policy issues for an organization with support for pagination and advanced filtering via the grid request format. Policy issues represent violations detected by Policy Packs during stack updates or continuous compliance scans. Each issue includes the violating resource, policy details, enforcement level (advisory or mandatory), severity, and triage status." }, { "info": { "name": "ExportPolicyIssues", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/policyresults/issues/export", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Exports policy issues for an organization to CSV format for offline analysis or reporting. Policy issues represent violations detected by Policy Packs during stack updates or continuous compliance scans. The export includes issue details such as the violating resource, policy name, enforcement level, and severity." }, { "info": { "name": "GetPolicyIssuesFilters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/policyresults/issues/filters", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the available filter options for listing policy issues, such as policy pack names, enforcement levels, severity values, and resource types. This is used to populate filter dropdowns in the policy issues UI." }, { "info": { "name": "GetPolicyIssue", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/policyresults/issues/:issueId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "issueId", "value": "", "type": "path", "description": "The issue identifier" } ] }, "docs": "Returns the details of a specific policy issue, including the violating resource, the policy pack and policy name that flagged the violation, the enforcement level (advisory or mandatory), severity, and the current triage status of the issue." }, { "info": { "name": "UpdatePolicyIssue", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName/policyresults/issues/:issueId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "issueId", "value": "", "type": "path", "description": "The issue identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a policy issue's triage status and other mutable fields. All body fields are optional — only provide the fields you want to update.\n\n- `status`: `open`, `in_progress`, `by_design`, `fixed`, or `ignored`\n- `priority`: `p0`, `p1`, `p2`, `p3`, or `p4`\n- `assignedTo`: username to assign the issue to, or `null` to unassign" }, { "info": { "name": "GetPolicyResultsMetadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/policyresults/metadata", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns high-level policy compliance statistics for an organization, including total violation counts, breakdown by severity and enforcement level, and trends over time. This provides an overview of the organization's policy compliance posture." }, { "info": { "name": "ListPoliciesCompliance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/policyresults/policies", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns policy compliance data grouped by policy pack and policy name, showing how many stacks are in compliance or violation for each individual policy rule. Supports pagination and filtering via the grid request format." }, { "info": { "name": "ListPolicyViolationsV2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/policyresults/violationsv2", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "ListPolicyViolationsV2Handler gets all the policy violations for an org.\nDeprecated: Use /policyresults/issues" }, { "info": { "name": "GetOrgRegistryPolicyPack", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/registry/policypacks/:policyPackName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "policyPackName", "value": "", "type": "path", "description": "The policy pack name" }, { "name": "tag", "value": "", "type": "query", "description": "Version tag to retrieve (e.g., 'latest')" } ] }, "docs": "Retrieves lightweight registry metadata for a policy pack (source/publisher/name) without loading detailed policy definitions." }, { "info": { "name": "GetUsageSummaryResourceHours", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/resources/summary", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "granularity", "value": "", "type": "query", "description": "Time granularity for aggregation (e.g., 'hourly', 'daily', 'monthly')" }, { "name": "lookbackDays", "value": "", "type": "query", "description": "Number of days to look back from the current time or lookbackStart" }, { "name": "lookbackStart", "value": "", "type": "query", "description": "Unix timestamp for the start of the lookback period (defaults to current time if omitted)" } ] }, "docs": "GetUsageSummaryResourceHours handles request to fetch the summary\nof resources under management (RUM) and resource hours under management\n(RHUM) for an organization." }, { "info": { "name": "ListDeletedStacks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/restore-stack", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "ListDeletedStacks returns the last 25 deleted stacks for a given org. It would be incredible to one day\nmerge this function with `ListOrganizationProjects` -- but that function is very bloated and not performant, so implementing\na lighter-weight handler focusing only on the most recently deleted stacks." }, { "info": { "name": "RestoreDeletedStack", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/restore-stack/:programID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "programID", "value": "", "type": "path", "description": "The program identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "RestoreDeletedStack un-deletes a soft-deleted stack for the given programID\nif the organization has the restore stacks feature enabled." }, { "info": { "name": "ListRolesByOrgIDAndUXPurpose", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/roles", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "uxPurpose", "value": "", "type": "query", "description": "Filter roles by their UX purpose (e.g., 'organization', 'team', 'token')" } ] }, "docs": "Returns custom roles for an organization filtered by their UX purpose (e.g., 'organization', 'team', or 'token'). This allows the UI to display only the roles relevant to the current context, such as showing only organization-level roles when managing member access." }, { "info": { "name": "CreateRole", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/roles", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "createPolicyAndRole", "value": "", "type": "query", "description": "Also create an associated policy and role binding alongside the role" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "ListAvailableScopes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/roles/scopes", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns all available permission scopes that can be assigned to custom roles, organized by category (e.g., stacks, teams, organization settings). Each scope represents a specific action or capability that can be granted or denied." }, { "info": { "name": "GetRole", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/roles/:roleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "roleID", "value": "", "type": "path", "description": "The role identifier" } ] }, "docs": "Returns the details of a specific custom role, including its name, description, and the set of permission scopes it grants. Custom roles enable fine-grained access control beyond the built-in admin and member roles." }, { "info": { "name": "UpdateRole", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName/roles/:roleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "roleID", "value": "", "type": "path", "description": "The role identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing custom role's name, description, or permission scopes. Changes take effect immediately for all members and teams assigned to the role." }, { "info": { "name": "DeleteRole", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/roles/:roleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "roleID", "value": "", "type": "path", "description": "The role identifier" }, { "name": "force", "value": "", "type": "query", "description": "Force deletion even if the role is currently assigned to members or teams" } ] }, "docs": "Deletes a custom role from an organization. If the role is currently assigned to members or teams, deletion requires the force parameter. Deleting a role revokes the permissions it granted to any assigned members or teams." }, { "info": { "name": "UpdateOrganizationDefaultRole", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName/roles/:roleID/default", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "roleID", "value": "", "type": "path", "description": "The role identifier" } ] }, "docs": "Sets the default custom role for the organization. New members who join the organization will be automatically assigned this role unless a different role is specified during the invitation process." }, { "info": { "name": "ListTeamsWithRole", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/roles/:roleID/teams", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "roleID", "value": "", "type": "path", "description": "The role identifier" } ] }, "docs": "ListTeamsWithRole" }, { "info": { "name": "ListOrgTokensWithRole", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/roles/:roleID/tokens", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "roleID", "value": "", "type": "path", "description": "The role identifier" } ] }, "docs": "Returns all organization tokens that have been assigned to a specific custom role. This helps administrators audit which tokens have particular permission levels and manage token-to-role assignments for least-privilege access." }, { "info": { "name": "ListUsersWithRole", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/roles/:roleID/users", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "roleID", "value": "", "type": "path", "description": "The role identifier" } ] }, "docs": "ListUsersWithRole" }, { "info": { "name": "GetSAMLOrganization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/saml", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns the SAML configuration data for an organization, including the SSO endpoint URL, identity provider metadata, and SAML attribute mappings. SAML-backed organizations use an external identity provider for user authentication and can enforce single sign-on for all members." }, { "info": { "name": "UpdateSAMLOrganization", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName/saml", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "ListSAMLOrganizationAdmins", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/saml/admins", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "ListSAMLOrganizationAdmins returns the list of SAML admins for an organization.\nWe currently only support one SAML admin per organization, where the SAML admin is\nthe user who onboarded the organization to SAML." }, { "info": { "name": "UpdateSAMLOrganizationAdmins", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/saml/admins/:userLogin", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "userLogin", "value": "", "type": "path", "description": "The user login name" } ] }, "docs": "Updates the SAML admin for an organization. The SAML admin is the user who manages the SAML SSO configuration. Currently, each organization supports only one SAML admin (typically the user who onboarded the organization to SAML). The new admin must not belong to other organizations." }, { "info": { "name": "SearchClusterAvailable", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/api/orgs/:orgName/search", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns a 200 response if the search cluster is available and healthy, 404 otherwise. This is a lightweight health check used to determine whether resource search functionality is operational for the organization." }, { "info": { "name": "GetResourceColumnFilterSet", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/search/column-set", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "field", "value": "", "type": "query", "description": "The resource field to aggregate (e.g., 'type', 'package', 'project')" }, { "name": "query", "value": "", "type": "query", "description": "Search query string" } ] }, "docs": "Returns aggregation results for a given field in resource search, providing the unique values and counts for a specific field like 'type', 'package', or 'project'. This is used to populate filter dropdowns and faceted navigation in the resource search UI." }, { "info": { "name": "GetOrgResourceSearchQuery", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/search/resources", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "collapse", "value": "", "type": "query", "description": "Collapse results to show one entry per stack instead of per resource" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor for paginated results" }, { "name": "facet", "value": "", "type": "query", "description": "Facet filters to apply" }, { "name": "groupBy", "value": "", "type": "query", "description": "Group results by this field" }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination" }, { "name": "properties", "value": "", "type": "query", "description": "Include resource properties in search results (may increase response size)" }, { "name": "query", "value": "", "type": "query", "description": "Search query string" }, { "name": "size", "value": "", "type": "query", "description": "Number of results to return" }, { "name": "sort", "value": "", "type": "query", "description": "Sort order for results" }, { "name": "top", "value": "", "type": "query", "description": "Number of top aggregation buckets to return" } ] }, "docs": "Searches for resources within an organization. Deprecated: use GetOrgResourceSearchV2Query for improved search functionality." }, { "info": { "name": "GetResourceDashboardAggregations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/search/resources/dashboard", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "GetResourceDashboardAggregations returns aggregated resource data for display on organization dashboard cards, including resource counts grouped by package and other dimensions." }, { "info": { "name": "ExportOrgResourceSearchQuery", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/search/resources/export", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "collapse", "value": "", "type": "query", "description": "Collapse results to show one entry per stack instead of per resource" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor for paginated results" }, { "name": "facet", "value": "", "type": "query", "description": "Facet filters to apply" }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination" }, { "name": "properties", "value": "", "type": "query", "description": "Include resource properties in search results (may increase response size)" }, { "name": "query", "value": "", "type": "query", "description": "Search query string" }, { "name": "size", "value": "", "type": "query", "description": "Number of results to return" }, { "name": "sort", "value": "", "type": "query", "description": "Sort order for results" }, { "name": "top", "value": "", "type": "query", "description": "Number of top aggregation buckets to return" } ] }, "docs": "ExportOrgResourceSearchQuery exports resource search results as a CSV file download. Supports the same query parameters as the standard resource search to filter results." }, { "info": { "name": "GetNaturalLanguageQuery", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/search/resources/parse", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "query", "value": "", "type": "query", "description": "Search query string" } ] }, "docs": "GetNaturalLanguageQuery converts a natural language query into a structured Pulumi search query using AI. For example, converts 'show me all S3 buckets in production' into a proper search syntax." }, { "info": { "name": "GetOrgResourceSearchV2Query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/search/resourcesv2", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "asc", "value": "", "type": "query", "description": "Sort in ascending order when true, descending when false" }, { "name": "collapse", "value": "", "type": "query", "description": "Collapse results to show one entry per stack instead of per resource" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor for paginated results" }, { "name": "facet", "value": "", "type": "query", "description": "Facet filters to apply" }, { "name": "groupBy", "value": "", "type": "query", "description": "Group results by this field" }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination" }, { "name": "properties", "value": "", "type": "query", "description": "Include resource properties in search results (may increase response size)" }, { "name": "query", "value": "", "type": "query", "description": "Search query string" }, { "name": "size", "value": "", "type": "query", "description": "Number of results to return" }, { "name": "sort", "value": "", "type": "query", "description": "Sort order for results" }, { "name": "top", "value": "", "type": "query", "description": "Number of top aggregation buckets to return" } ] }, "docs": "Searches for resources within an organization with advanced filtering, sorting, and pagination capabilities.\n\n**Pagination:** The `page` parameter supports up to 10,000 results. For larger result sets, use the `cursor` parameter instead (Enterprise plans only). Note that pagination is not transactional — result ordering may change if a stack update completes during pagination.\n\n**Sorting:** The `sort` parameter accepts: `created`, `custom`, `delete`, `dependencies`, `id`, `modified`, `module`, `" }, { "info": { "name": "GetUsageSummaryEnvironmentSecrets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/secrets/summary", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "granularity", "value": "", "type": "query", "description": "Time granularity for aggregation (e.g., 'hourly', 'daily', 'monthly')" }, { "name": "lookbackDays", "value": "", "type": "query", "description": "Number of days to look back from the current time or lookbackStart" }, { "name": "lookbackStart", "value": "", "type": "query", "description": "Unix timestamp for the start of the lookback period (defaults to current time if omitted)" } ] }, "docs": "GetUsageSummaryEnvironmentSecrets handles request to fetch the summary\nof ESC secret hours for an organization." }, { "info": { "name": "ListServices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/services", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns all service accounts in an organization. Service accounts provide programmatic, non-human identities for accessing Pulumi Cloud resources. They can hold access tokens, belong to teams, and have stack permissions, making them suitable for CI/CD pipelines, automation tools, and other machine-to-machine integrations." }, { "info": { "name": "CreateService", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/services", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetService", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/services/:ownerType/:ownerName/:serviceName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "ownerType", "value": "", "type": "path", "description": "The owner type" }, { "name": "ownerName", "value": "", "type": "path", "description": "The owner name" }, { "name": "serviceName", "value": "", "type": "path", "description": "The service name" } ] }, "docs": "Returns the details of a specific service account, including its name, owner, description, team memberships, access tokens, and stack permissions. Service accounts provide programmatic, non-human access to Pulumi Cloud resources and are identified by their owner type, owner name, and service name." }, { "info": { "name": "UpdateService", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName/services/:ownerType/:ownerName/:serviceName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "ownerType", "value": "", "type": "path", "description": "The owner type" }, { "name": "ownerName", "value": "", "type": "path", "description": "The owner name" }, { "name": "serviceName", "value": "", "type": "path", "description": "The service name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the metadata and configuration of an existing service account, such as its description, team memberships, and access settings. Service accounts provide programmatic, non-human access to Pulumi Cloud resources." }, { "info": { "name": "DeleteService", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/services/:ownerType/:ownerName/:serviceName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "ownerType", "value": "", "type": "path", "description": "The owner type" }, { "name": "ownerName", "value": "", "type": "path", "description": "The owner name" }, { "name": "serviceName", "value": "", "type": "path", "description": "The service name" }, { "name": "force", "value": "", "type": "query", "description": "Force deletion even if the service has other members" } ] }, "docs": "Deletes a service account from an organization. Service accounts provide programmatic, non-human access to Pulumi Cloud resources. If the service has other members, deletion requires explicit confirmation via the force parameter. All access tokens and permissions associated with the service are revoked." }, { "info": { "name": "HeadService", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/api/orgs/:orgName/services/:ownerType/:ownerName/:serviceName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "ownerType", "value": "", "type": "path", "description": "The owner type" }, { "name": "ownerName", "value": "", "type": "path", "description": "The owner name" }, { "name": "serviceName", "value": "", "type": "path", "description": "The service name" } ] }, "docs": "Checks whether a service account exists in the organization without returning its full details. Returns 204 No Content if the service exists, or an error if not found. This is a lightweight check useful for validating service account references." }, { "info": { "name": "AddServiceItems", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/services/:ownerType/:ownerName/:serviceName/items", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "ownerType", "value": "", "type": "path", "description": "The owner type" }, { "name": "ownerName", "value": "", "type": "path", "description": "The owner name" }, { "name": "serviceName", "value": "", "type": "path", "description": "The service name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "RemoveServiceItem", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/services/:ownerType/:ownerName/:serviceName/items/:itemType/:itemName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "ownerType", "value": "", "type": "path", "description": "The owner type" }, { "name": "ownerName", "value": "", "type": "path", "description": "The owner name" }, { "name": "serviceName", "value": "", "type": "path", "description": "The service name" }, { "name": "itemType", "value": "", "type": "path", "description": "The item type" }, { "name": "itemName", "value": "", "type": "path", "description": "The item name" } ] }, "docs": "Removes a specific item (such as a team membership, access token, or stack permission) from a service account. Returns the updated service details after the item has been removed." }, { "info": { "name": "ListTeams", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/teams", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Retrieves all teams within an organization. Teams provide a centralized way to manage stack access permissions for groups of users. The response includes each team's name, type (Pulumi-managed, GitHub-backed, or GitLab-backed), member count, and summary of stack permissions. Teams are available to organizations on Enterprise and Business Critical editions." }, { "info": { "name": "CreateGitHubTeam", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/teams/github", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Pulumi team backed by a GitHub team. When an organization is backed by GitHub, existing GitHub teams can be imported into Pulumi to manage stack permissions. Membership is managed through GitHub while stack access permissions are controlled within Pulumi Cloud. The request must include the GitHub team ID. Returns 409 if a team with the same name already exists." }, { "info": { "name": "CreatePulumiTeam", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/teams/pulumi", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "CreatePulumiTeam creates a \"Pulumi\" team, i.e. one whose membership is managed by Pulumi.\n(As opposed to a GitHub or GitLab-based team.)" }, { "info": { "name": "GetTeam", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/teams/:teamName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "teamName", "value": "", "type": "path", "description": "The team name" } ] }, "docs": "Retrieves detailed information about a specific team within an organization. The response includes the team name, display name, description, team type (Pulumi-managed, GitHub-backed, or GitLab-backed), list of members with their roles (team admin or team member), and the stack permissions granted to the team. Teams provide a centralized way to manage stack access for groups of users." }, { "info": { "name": "UpdateTeam", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName/teams/:teamName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "teamName", "value": "", "type": "path", "description": "The team name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a team's membership and configuration. This multi-purpose endpoint supports several operations:\n\n**Update membership:** Use `member` (username) and `memberAction` (`add` or `remove`) to manage team members.\n\n**Grant stack access:** Use `addStackPermission` with `projectName`, `stackName`, and `permission` (integer: `101` = read, `102` = edit, `103` = admin).\n\n**Remove stack access:** Use `removeStack` with `projectName` and `stackName`.\n\nMembers added to a team inherit the team's stack p" }, { "info": { "name": "DeleteTeam", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/teams/:teamName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "teamName", "value": "", "type": "path", "description": "The team name" } ] }, "docs": "Permanently removes a team from an organization. All stack permission grants assigned to the team are revoked, and team members lose any access that was granted solely through team membership. Team tokens associated with the team are also invalidated. This action cannot be undone." }, { "info": { "name": "EnableTeamRoles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/teams/:teamName/enable-team-roles", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "teamName", "value": "", "type": "path", "description": "The team name" } ] }, "docs": "Enables custom role-based access control for a team. Once enabled, the team can be assigned custom roles that define fine-grained permissions beyond the default team admin and team member roles. Returns the created role descriptor." }, { "info": { "name": "ListTeamRoles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/teams/:teamName/roles", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "teamName", "value": "", "type": "path", "description": "The team name" } ] }, "docs": "ListTeamRoles will list the roles for a team. For now, this will always be a\nlist of one, since we currently only support one role per team." }, { "info": { "name": "UpdateTeamRoles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/teams/:teamName/roles/:roleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "teamName", "value": "", "type": "path", "description": "The team name" }, { "name": "roleID", "value": "", "type": "path", "description": "The role identifier" } ] }, "docs": "UpdateTeamRoles upserts the role assigned to a team since we currently only support\na 1:1 mapping of teams to roles." }, { "info": { "name": "DeleteTeamRole", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/teams/:teamName/roles/:roleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "teamName", "value": "", "type": "path", "description": "The team name" }, { "name": "roleID", "value": "", "type": "path", "description": "The role identifier" } ] }, "docs": "Removes a custom role assignment from a team. This revokes the permissions that were granted to team members through the role. Currently only one role can be assigned per team." }, { "info": { "name": "ListTeamTokens", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/teams/:teamName/tokens", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "teamName", "value": "", "type": "path", "description": "The team name" }, { "name": "filter", "value": "", "type": "query", "description": "Filter tokens by status (e.g., include expired tokens)" } ] }, "docs": "Retrieves all access tokens for a specific team. Team tokens inherit the stack permissions assigned to the team, providing scoped CI/CD automation access. The response includes token metadata such as name, description, creation date, last used date, and expiration status. The actual token values are never returned after initial creation. An optional filter parameter can include expired tokens." }, { "info": { "name": "CreateTeamToken", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/teams/:teamName/tokens", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "teamName", "value": "", "type": "path", "description": "The team name" }, { "name": "reason", "value": "", "type": "query", "description": "Audit log reason for creating this token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\nThe `name` field must be unique across the organization (including deleted tokens) and cannot exceed 40 characters. The `expires` field accepts a unix epoch timestamp up to two years from the present, or `0` for no expiry (default).\n\n**Important:** The token va" }, { "info": { "name": "DeleteTeamToken", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/teams/:teamName/tokens/:tokenId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "teamName", "value": "", "type": "path", "description": "The team name" }, { "name": "tokenId", "value": "", "type": "path", "description": "The access token identifier" }, { "name": "reason", "value": "", "type": "query", "description": "Audit log reason for deleting this token" } ] }, "docs": "Permanently revokes and deletes a team access token. Any CI/CD pipelines or automation using this token will immediately lose access to the stacks assigned to the team. This action cannot be undone." }, { "info": { "name": "GetProjectTemplate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/template", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "GetProjectTemplate attempts to fetch Pulumi.yaml from a template\nrepository. If the repository represents a valid template, we return a\nresponse identical to the format we use for the public pulumi/templates\nrepo.\n\nThis API accepts either a `url` or `project` query param to denote\neither where to fetch the project template from or which project's\npre-configured template to use respectively. If both are passed in `project`\ntake precedence, falling back to `url` if there is no source configured on" }, { "info": { "name": "GetProjectTemplateConfiguration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/template/configuration", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "GetProjectTemplateConfiguration attempts to lookup any config we store\nfor the template using the template query parameter passed in as a key\ninto the org's template sources." }, { "info": { "name": "GetOrgTemplateDownload", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/template/download", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Downloads a template archive for an organization as an application/x-tar binary stream. The template is identified by a URL query parameter pointing to the template source. Returns the tar archive containing the template's project files and configuration." }, { "info": { "name": "GetOrgTemplateReadme", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/template/readme", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns the README content for an organization template as Markdown text. The template is identified by a URL query parameter. Returns 404 if the template does not contain a README.md file, or 422 if the README content is invalid." }, { "info": { "name": "GetOrgTemplates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/templates", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns a combined list of all templates available to the organization and the current user. This includes templates from the organization's configured template collections as well as Pulumi's built-in public templates. Each template includes its name, description, language, and source URL." }, { "info": { "name": "GetOrgTemplateCollections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/templates/sources", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns all template collections (sources) configured for an organization. Template collections define where project templates are sourced from, such as Git repositories. Each collection includes its name, URL, and the templates it provides." }, { "info": { "name": "CreateOrgTemplateCollection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/templates/sources", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "UpdateOrgTemplateCollection", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName/templates/sources/:templateID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "templateID", "value": "", "type": "path", "description": "The template identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing template collection for an organization, allowing modification of the template source URL, name, or other configuration. Template collections define where project templates are sourced from." }, { "info": { "name": "DeleteOrgTemplateCollection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/templates/sources/:templateID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "templateID", "value": "", "type": "path", "description": "The template identifier" } ] }, "docs": "Removes a template collection (source) from an organization. Templates sourced from this collection will no longer be available to organization members when creating new stacks. Returns 400 if the template ID is invalid, or 404 if the template source does not exist." }, { "info": { "name": "ListOrgTokens", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/tokens", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "filter", "value": "", "type": "query", "description": "Filter tokens by status (e.g., include expired tokens)" } ] }, "docs": "Retrieves all access tokens created for an organization. Organization tokens provide CI/CD automation access scoped to the organization rather than tied to individual user accounts. The response includes token metadata such as name, description, creation date, last used date, and expiration status. The actual token values are never returned after initial creation. An optional filter parameter can include expired tokens in the results." }, { "info": { "name": "CreateOrgToken", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/tokens", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "reason", "value": "", "type": "query", "description": "Audit log reason for creating this token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\nThe `name` field must be unique across the organization (including deleted tokens) and cannot exceed 40 characters. The `expires` field accepts a unix epoch timestamp up to two years from the present, or `0` for no expiry (default).\n\n**Important:** Th" }, { "info": { "name": "DeleteOrgToken", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/tokens/:tokenId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "tokenId", "value": "", "type": "path", "description": "The access token identifier" } ] }, "docs": "Permanently revokes and deletes an organization access token. Any CI/CD pipelines or automation using this token will immediately lose access to the organization's resources. This action cannot be undone." }, { "info": { "name": "BatchDecryptProjectValue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:orgName/:projectName/batch-decrypt", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "BatchDecryptProjectValue works just like BatchDecryptValueHandler, but using the project's encryption key instead of the stack's" }, { "info": { "name": "DecryptProjectValue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:orgName/:projectName/decrypt", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "DecryptProjectValue works just like DecryptValueHandler, but using the project's encryption key instead of the stack's" }, { "info": { "name": "EncryptProjectValue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:orgName/:projectName/encrypt", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "EncryptProjectValue encrypts a value using the project's key. The request body contains the base64\nencoded value to be encrypted." }, { "info": { "name": "CreateStack", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\nThe optional `config` object supports:\n- `environment`: reference to an ESC environment for storing stack configuration (must not already exist)\n- `secretsProvider`: the" }, { "info": { "name": "ProjectExists", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" } ] }, "docs": "Checks whether a project exists within an organization. Returns 200 with the project name if it exists, or 404 if not found. This is a lightweight existence check useful for validating project names before creating stacks or performing other operations." } ] }, { "info": { "name": "VCS Integrations", "type": "folder" }, "items": [ { "info": { "name": "ListAllVCSIntegrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns a summary of all VCS integrations across all providers (GitHub, GitLab, Azure DevOps, Custom) for an organization. Each integration includes a hasIndividualAccess flag indicating whether the current user has an OAuth token for that provider." }, { "info": { "name": "ListAzureDevOpsIntegrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/azure-devops", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Lists all Azure DevOps integrations configured for an organization." }, { "info": { "name": "CreateAzureDevOpsSetup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/azure-devops", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Azure DevOps integration for an organization. Requires an Azure DevOps organization and project to be specified in the request body. Returns 409 if an integration already exists for the specified project." }, { "info": { "name": "GetAzureDevOpsAccessStatus", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/azure-devops/access-status", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns information about a user's Azure DevOps access status for an organization, including whether the user has a valid OAuth token." }, { "info": { "name": "CompleteAzureDevOpsOAuth", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/azure-devops/oauth/complete", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Completes the OAuth authorization flow for Azure DevOps VCS integration by exchanging the authorization code for access and refresh tokens." }, { "info": { "name": "InitiateAzureDevOpsOAuth", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/azure-devops/oauth/initiate", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the OAuth authorization flow for Azure DevOps VCS integration. Returns a redirect URL that the user should be directed to for authorization." }, { "info": { "name": "ListAzureDevOpsOrganizations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/azure-devops/setup/organizations", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Lists Azure DevOps organizations available to the current user. Requires an active Azure DevOps OAuth token." }, { "info": { "name": "ListAzureDevOpsProjects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/azure-devops/setup/organizations/:adoOrgName/projects", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "adoOrgName", "value": "", "type": "path", "description": "The Azure DevOps organization name" } ] }, "docs": "Lists Azure DevOps projects within a specified Azure DevOps organization that are available to the current user." }, { "info": { "name": "GetAzureDevOpsIntegration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/azure-devops/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The Azure DevOps integration identifier" } ] }, "docs": "Gets a specific Azure DevOps integration by its integration ID. Returns the integration details including organization, project, and authentication configuration." }, { "info": { "name": "UpdateAzureDevOpsIntegration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/azure-devops/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The Azure DevOps integration identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing Azure DevOps integration's settings. Can modify the Azure DevOps organization, project, or authentication configuration." }, { "info": { "name": "DeleteAzureDevOpsIntegration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/azure-devops/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The Azure DevOps integration identifier" } ] }, "docs": "Removes a specific Azure DevOps integration from the organization." }, { "info": { "name": "ListBitBucketIntegrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/bitbucket", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Lists all BitBucket integrations configured for an organization, including their validity status and linked workspace metadata." }, { "info": { "name": "CreateBitBucketSetup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/bitbucket", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new BitBucket integration for an organization. Requires a BitBucket workspace UUID and optionally configures authentication via the user's BitBucket OAuth token or a workspace access token / PAT. Returns 409 if an integration already exists for the specified workspace." }, { "info": { "name": "GetBitBucketAccessStatus", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/bitbucket/access-status", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns information about a user's BitBucket access status for an organization, including whether they have a valid OAuth token and available BitBucket workspaces for new integrations." }, { "info": { "name": "GetBitBucketIntegration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/bitbucket/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The BitBucket integration identifier" } ] }, "docs": "Gets a specific BitBucket integration by its integration ID. Returns the integration details including the linked BitBucket workspace, authentication configuration, and validity status." }, { "info": { "name": "UpdateBitBucketIntegration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/bitbucket/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The BitBucket integration identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing BitBucket integration's settings, such as PR comment preferences and AI summary options." }, { "info": { "name": "DeleteBitBucketIntegration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/bitbucket/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The BitBucket integration identifier" } ] }, "docs": "Removes a specific BitBucket integration from the organization. Cleans up associated webhooks and access tokens." }, { "info": { "name": "ListCustomVCSIntegrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/custom", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Lists all custom VCS integrations configured for an organization. Returns each integration's configuration, webhook URL, and configured repositories. Webhook secrets are not included in list responses." }, { "info": { "name": "CreateCustomVCSIntegration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/custom", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetCustomVCSIntegration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/custom/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The custom VCS integration identifier" } ] }, "docs": "Gets a specific custom VCS integration by its integration ID. Returns the integration details including its configuration, webhook URL, and configured repositories. The webhook secret is not included; it is only returned at creation time or when regenerated via update." }, { "info": { "name": "UpdateCustomVCSIntegration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/custom/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The custom VCS integration identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing custom VCS integration's settings. All fields are optional; only provided fields are modified. Set regenerateWebhookSecret to true to rotate the webhook HMAC secret, which invalidates the previous secret immediately." }, { "info": { "name": "DeleteCustomVCSIntegration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/custom/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The custom VCS integration identifier" } ] }, "docs": "Removes a specific custom VCS integration from the organization. This permanently deletes the integration, its webhook endpoint, and all configured repository associations." }, { "info": { "name": "AddCustomVCSRepository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/custom/:integrationId/repos", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The custom VCS integration identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "RemoveCustomVCSRepository", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/custom/:integrationId/repos", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The custom VCS integration identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a repository from a custom VCS integration. The repository is identified by its name, as provided in the request. Returns 404 if the integration or repository is not found." }, { "info": { "name": "ListGitHubIntegrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/github", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Lists all GitHub App integrations for an organization." }, { "info": { "name": "StartGitHubSetup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/github", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Initiates GitHub App setup, returns installation URL with state." }, { "info": { "name": "ListGitHubEnterpriseIntegrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/github-enterprise", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Lists all GitHub Enterprise Server integrations for an organization. Returns only self-hosted GitHub App installations." }, { "info": { "name": "GetGitHubEnterpriseIntegration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/github-enterprise/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The GitHub Enterprise integration identifier" } ] }, "docs": "Gets a specific GitHub Enterprise Server integration." }, { "info": { "name": "UpdateGitHubEnterpriseIntegration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/github-enterprise/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The GitHub Enterprise integration identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates GitHub Enterprise Server integration settings." }, { "info": { "name": "DeleteGitHubEnterpriseIntegration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/github-enterprise/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The GitHub Enterprise integration identifier" } ] }, "docs": "Removes a GitHub Enterprise Server integration." }, { "info": { "name": "GetGitHubAccess", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/github/access-status", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns information about a user's GitHub OAuth status." }, { "info": { "name": "GetGitHubIntegration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/github/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The GitHub App integration identifier" } ] }, "docs": "Gets a specific GitHub App integration by its integration ID. Returns the integration details including installation ID, account info, PR comment settings, and permission status. Returns 404 if the integration is not found." }, { "info": { "name": "UpdateGitHubIntegration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/github/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The GitHub App integration identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates GitHub App integration settings." }, { "info": { "name": "DeleteGitHubIntegration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/github/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The GitHub App integration identifier" } ] }, "docs": "Removes a GitHub App integration." }, { "info": { "name": "ListGitLabIntegrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/gitlab", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Lists all GitLab integrations configured for an organization, including their validity status and linked group metadata." }, { "info": { "name": "CreateGitLabSetup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/gitlab", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new GitLab integration for an organization. Requires a GitLab group ID and optionally configures authentication via the user's GitLab OAuth token or a group access token. Returns 409 if an integration already exists for the specified group." }, { "info": { "name": "GetGitLabAccessStatus", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/gitlab/access-status", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns information about a user's GitLab access status for an organization, including whether they have a valid OAuth token, existing integrations, and available GitLab groups for new integrations." }, { "info": { "name": "GetGitLabIntegration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/gitlab/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The GitLab integration identifier" } ] }, "docs": "Gets a specific GitLab integration by its integration ID. Returns the integration details including the linked GitLab group, authentication configuration, and validity status." }, { "info": { "name": "UpdateGitLabIntegration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/gitlab/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The GitLab integration identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing GitLab integration's settings, such as PR comment preferences and AI summary options." }, { "info": { "name": "DeleteGitLabIntegration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/gitlab/:integrationId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "integrationId", "value": "", "type": "path", "description": "The GitLab integration identifier" } ] }, "docs": "Removes a specific GitLab integration from the organization. Cleans up associated webhooks, access tokens, and group tokens." }, { "info": { "name": "ListVCSRepos", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/:provider/:integrationId/repos", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "provider", "value": "", "type": "path", "description": "The VCS provider (e.g., 'github')" }, { "name": "integrationId", "value": "", "type": "path", "description": "The VCS integration identifier" }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination" } ] }, "docs": "Lists repositories available through the integration." }, { "info": { "name": "ListVCSRepoDestinations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/:provider/:integrationId/repos/destinations", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "provider", "value": "", "type": "path", "description": "The VCS provider (e.g., 'github')" }, { "name": "integrationId", "value": "", "type": "path", "description": "The VCS integration identifier" } ] }, "docs": "Lists repositories where the authenticated user can create new repos from templates via the integration." }, { "info": { "name": "ListVCSBranches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/integrations/:provider/:integrationId/repos/:repoId/branches", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "provider", "value": "", "type": "path", "description": "The VCS provider (e.g., 'github')" }, { "name": "integrationId", "value": "", "type": "path", "description": "The VCS integration identifier" }, { "name": "repoId", "value": "", "type": "path", "description": "The repository identifier" } ] }, "docs": "Lists branches for a repository." } ] }, { "info": { "name": "Stacks", "type": "folder" }, "items": [ { "info": { "name": "ListMemberStackPermissions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/orgs/:orgName/members/:userLogin/stacks/:projectName/:stackName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "userLogin", "value": "", "type": "path", "description": "The user login" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "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." }, { "info": { "name": "GetStackOverview", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/stacks/:orgName/:projectName/:stackName/overview", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Returns 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." }, { "info": { "name": "UpdateTeamStackPermissions", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/console/stacks/:orgName/:projectName/:stackName/teams/:teamName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "teamName", "value": "", "type": "path", "description": "The team name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "UpdateSummaryHandlerLatest", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/stacks/:orgName/:projectName/:stackName/updates/latest/summary", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Returns 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." }, { "info": { "name": "UpdateSummary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/console/stacks/:orgName/:projectName/:stackName/updates/:updateID/summary", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ] }, "docs": "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." }, { "info": { "name": "GetStack", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Retrieves 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." }, { "info": { "name": "DeleteStack", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "force", "value": "", "type": "query", "description": "When true, forces deletion even if the stack still has resources" } ] }, "docs": "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." }, { "info": { "name": "GetStackActivity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/activity", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "page", "value": "", "type": "query", "description": "Page number for paginated results (0-indexed, where 0 returns all results)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results per page (must be >= 1 when page > 0)" } ] }, "docs": "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." }, { "info": { "name": "GetStacksAnnotation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/annotations/:kind", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "kind", "value": "", "type": "path", "description": "The annotation kind" }, { "name": "source", "value": "", "type": "query", "description": "The annotation source" }, { "name": "version", "value": "", "type": "query", "description": "The annotation version number, used for filtering by a specific version" } ] }, "docs": "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." }, { "info": { "name": "UpsertStacksAnnotations", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/annotations/:kind", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "kind", "value": "", "type": "path", "description": "The annotation kind" }, { "name": "source", "value": "", "type": "query", "description": "The annotation source" }, { "name": "version", "value": "", "type": "query", "description": "The expected annotation version for optimistic concurrency control" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "BatchDecryptValue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/batch-decrypt", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "BatchEncryptValue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/batch-encrypt", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Encrypts a 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." }, { "info": { "name": "ListStackPermissions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/collaborators", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "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." }, { "info": { "name": "DeleteStackPermission", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/collaborators/:userName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "userName", "value": "", "type": "path", "description": "The user name" } ] }, "docs": "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." }, { "info": { "name": "GetStackConfig", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/config", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Retrieves the 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." }, { "info": { "name": "UpdateStackConfig", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/config", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "DeleteStackConfig", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/config", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Removes 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." }, { "info": { "name": "DecryptValue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/decrypt", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "LogOnlyBatchDecryptValue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/decrypt/log-batch-decryption", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "LogOnlyDecryptValue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/decrypt/log-decryption", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "CreateUpdateForDestroy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/destroy", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a 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." }, { "info": { "name": "GetUpdateStatusForDestroy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/destroy/:updateID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" } ] }, "docs": "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." }, { "info": { "name": "StartUpdateForDestroy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/destroy/:updateID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "CancelUpdate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/destroy/:updateID/cancel", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ] }, "docs": "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." }, { "info": { "name": "PatchUpdateCheckpoint", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/destroy/:updateID/checkpoint", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "PatchUpdateCheckpointDelta", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/destroy/:updateID/checkpointdelta", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 " }, { "info": { "name": "PatchUpdateVerbatimCheckpoint", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/destroy/:updateID/checkpointverbatim", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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, " }, { "info": { "name": "CompleteUpdate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/destroy/:updateID/complete", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetEngineEvents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/destroy/:updateID/events", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "include_non_activated", "value": "", "type": "query", "description": "When true, includes events that have not yet been activated; when false or omitted, only activated events are returned" }, { "name": "type", "value": "", "type": "query", "description": "Filter results to only include events matching these engine event type codes" }, { "name": "urn", "value": "", "type": "query", "description": "Filter results to only include events for the specified resource URN" } ] }, "docs": "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." }, { "info": { "name": "RecordEngineEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/destroy/:updateID/events", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "RecordEngineEventBatch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/destroy/:updateID/events/batch", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "CreateJournalEntries", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/destroy/:updateID/journalentries", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" }, { "name": "include_non_activated", "value": "", "type": "query", "description": "When true, includes events that have not yet been activated; when false or omitted, only activated events are returned" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "AppendUpdateLogEntry", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/destroy/:updateID/log", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "RenewUpdateLease", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/destroy/:updateID/renew_lease", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "ListDownstreamStackReferences", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/downstreamreferences", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Returns all 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." }, { "info": { "name": "EncryptValue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/encrypt", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Encrypts a 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." }, { "info": { "name": "ExportStack", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/export", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "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." }, { "info": { "name": "ExportStackAtVersion", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/export/:version", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "version", "value": "", "type": "path", "description": "The stack update version number" } ] }, "docs": "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." }, { "info": { "name": "ListStackWebhooks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/hooks", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Returns all webhooks configured for the specified stack. Each webhook in the response includes its name, display name, payload URL, format, filters, and active status." }, { "info": { "name": "CreateStackWebhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/hooks", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new webhook for the specified stack. The request body must include the webhook name, payload URL, and format.\n\nThe `format` field accepts: `raw` (default), `slack`, `ms_teams`, or `pulumi_deployments`.\n\nThe `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.\n\nThe optional `secret` field sets the HMAC key for signature verification. See th" }, { "info": { "name": "GetStackWebhook", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/hooks/:hookName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ] }, "docs": "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." }, { "info": { "name": "UpdateStackWebhook", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/hooks/:hookName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "DeleteStackWebhook", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/hooks/:hookName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ] }, "docs": "Deletes a webhook from the specified stack. Returns 204 with no content on success." }, { "info": { "name": "GetStackWebhookDeliveries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/hooks/:hookName/deliveries", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ] }, "docs": "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." }, { "info": { "name": "RedeliverStackWebhookEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/hooks/:hookName/deliveries/:event/redeliver", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" }, { "name": "event", "value": "", "type": "path", "description": "The webhook delivery event identifier to redeliver" } ] }, "docs": "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." }, { "info": { "name": "PingStackWebhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/hooks/:hookName/ping", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ] }, "docs": "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." }, { "info": { "name": "ImportStack", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/import", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetStackMetadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/metadata", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Returns metadata about 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." }, { "info": { "name": "UpdateStackNotificationSettings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/notifications/settings", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "ReassignStackOwnership", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/ownership", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes the ownership of the specified stack to the provided user. Returns the identity of the previous owner." }, { "info": { "name": "GetStackPolicyGroups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/policygroups", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Returns 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." }, { "info": { "name": "GetStackPolicyPacks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/policypacks", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "mode", "value": "", "type": "query", "description": "Filter by policy group enforcement mode ('audit' or 'preventative')" } ] }, "docs": "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." }, { "info": { "name": "CreateUpdateForPreview", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/preview", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a 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." }, { "info": { "name": "GetUpdateStatusForPreview", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/preview/:updateID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" } ] }, "docs": "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." }, { "info": { "name": "StartUpdateForPreview", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/preview/:updateID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "CancelUpdate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/preview/:updateID/cancel", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ] }, "docs": "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." }, { "info": { "name": "CompleteUpdate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/preview/:updateID/complete", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetEngineEvents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/preview/:updateID/events", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "include_non_activated", "value": "", "type": "query", "description": "When true, includes events that have not yet been activated; when false or omitted, only activated events are returned" }, { "name": "type", "value": "", "type": "query", "description": "Filter results to only include events matching these engine event type codes" }, { "name": "urn", "value": "", "type": "query", "description": "Filter results to only include events for the specified resource URN" } ] }, "docs": "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." }, { "info": { "name": "RecordEngineEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/preview/:updateID/events", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "RecordEngineEventBatch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/preview/:updateID/events/batch", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "CreateJournalEntries", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/preview/:updateID/journalentries", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" }, { "name": "include_non_activated", "value": "", "type": "query", "description": "When true, includes events that have not yet been activated; when false or omitted, only activated events are returned" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "AppendUpdateLogEntry", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/preview/:updateID/log", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "RenewUpdateLease", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/preview/:updateID/renew_lease", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetStackPreview", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/previews/:updateID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ] }, "docs": "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." }, { "info": { "name": "GetStackPreviewSummary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/previews/:updateID/summary", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ] }, "docs": "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." }, { "info": { "name": "CreateUpdateForRefresh", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/refresh", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a 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." }, { "info": { "name": "GetUpdateStatusForRefresh", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/refresh/:updateID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" } ] }, "docs": "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." }, { "info": { "name": "StartUpdateForRefresh", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/refresh/:updateID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "CancelUpdate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/refresh/:updateID/cancel", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ] }, "docs": "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." }, { "info": { "name": "PatchUpdateCheckpoint", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/refresh/:updateID/checkpoint", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "PatchUpdateCheckpointDelta", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/refresh/:updateID/checkpointdelta", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 " }, { "info": { "name": "PatchUpdateVerbatimCheckpoint", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/refresh/:updateID/checkpointverbatim", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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, " }, { "info": { "name": "CompleteUpdate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/refresh/:updateID/complete", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetEngineEvents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/refresh/:updateID/events", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "include_non_activated", "value": "", "type": "query", "description": "When true, includes events that have not yet been activated; when false or omitted, only activated events are returned" }, { "name": "type", "value": "", "type": "query", "description": "Filter results to only include events matching these engine event type codes" }, { "name": "urn", "value": "", "type": "query", "description": "Filter results to only include events for the specified resource URN" } ] }, "docs": "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." }, { "info": { "name": "RecordEngineEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/refresh/:updateID/events", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "RecordEngineEventBatch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/refresh/:updateID/events/batch", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "CreateJournalEntries", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/refresh/:updateID/journalentries", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" }, { "name": "include_non_activated", "value": "", "type": "query", "description": "When true, includes events that have not yet been activated; when false or omitted, only activated events are returned" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "AppendUpdateLogEntry", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/refresh/:updateID/log", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "RenewUpdateLease", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/refresh/:updateID/renew_lease", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "RenameStack", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/rename", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetStackResourceCount", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/resources/count", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Returns 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." }, { "info": { "name": "GetLatestStackResources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/resources/latest", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Retrieves 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." }, { "info": { "name": "GetLatestStackResource", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/resources/latest/:urn", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "urn", "value": "", "type": "path", "description": "The resource URN" } ] }, "docs": "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." }, { "info": { "name": "GetStackResources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/resources/:version", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "version", "value": "", "type": "path", "description": "The stack update version number" } ] }, "docs": "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." }, { "info": { "name": "GetStackResource", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/resources/:version/:urn", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "version", "value": "", "type": "path", "description": "The stack update version number" }, { "name": "urn", "value": "", "type": "path", "description": "The resource URN" } ] }, "docs": "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." }, { "info": { "name": "AddStackTag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a 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." }, { "info": { "name": "UpdateStackTags", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "UpdateStackTag", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "tagName", "value": "", "type": "path", "description": "The tag name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "DeleteStackTag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "tagName", "value": "", "type": "path", "description": "The tag name" } ] }, "docs": "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." }, { "info": { "name": "ListStackTeams", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/teams", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "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." }, { "info": { "name": "TransferStack", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/transfer", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "CreateUpdateForUpdate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/update", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a 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." }, { "info": { "name": "GetUpdateStatusForUpdate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/update/:updateID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" } ] }, "docs": "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." }, { "info": { "name": "StartUpdateForUpdate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/update/:updateID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "CancelUpdate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/update/:updateID/cancel", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ] }, "docs": "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." }, { "info": { "name": "PatchUpdateCheckpoint", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/update/:updateID/checkpoint", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "PatchUpdateCheckpointDelta", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/update/:updateID/checkpointdelta", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 " }, { "info": { "name": "PatchUpdateVerbatimCheckpoint", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/update/:updateID/checkpointverbatim", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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, " }, { "info": { "name": "CompleteUpdate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/update/:updateID/complete", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetEngineEvents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/update/:updateID/events", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "include_non_activated", "value": "", "type": "query", "description": "When true, includes events that have not yet been activated; when false or omitted, only activated events are returned" }, { "name": "type", "value": "", "type": "query", "description": "Filter results to only include events matching these engine event type codes" }, { "name": "urn", "value": "", "type": "query", "description": "Filter results to only include events for the specified resource URN" } ] }, "docs": "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." }, { "info": { "name": "RecordEngineEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/update/:updateID/events", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "RecordEngineEventBatch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/update/:updateID/events/batch", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "CreateJournalEntries", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/update/:updateID/journalentries", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" }, { "name": "include_non_activated", "value": "", "type": "query", "description": "When true, includes events that have not yet been activated; when false or omitted, only activated events are returned" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "AppendUpdateLogEntry", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/update/:updateID/log", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "RenewUpdateLease", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/update/:updateID/renew_lease", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "updateID", "value": "", "type": "path", "description": "The update ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetStackUpdates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/updates", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "output-type", "value": "", "type": "query", "description": "Controls the response format; when unset returns the legacy format, otherwise returns the paginated format" }, { "name": "page", "value": "", "type": "query", "description": "Page number for paginated results (0-indexed, where 0 returns all results)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results per page (must be >= 1 when page > 0)" } ] }, "docs": "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." }, { "info": { "name": "GetLatestStackUpdate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/updates/latest", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Returns 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." }, { "info": { "name": "GetLatestStackPreviews", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/updates/latest/previews", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "asc", "value": "", "type": "query", "description": "When true, sorts results in ascending chronological order; when false or omitted, sorts in descending order" }, { "name": "page", "value": "", "type": "query", "description": "Page number for paginated results (0-indexed, where 0 returns all results)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results per page (must be >= 1 when page > 0)" } ] }, "docs": "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)." }, { "info": { "name": "GetLatestUpdateTimeline", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/updates/latest/timeline", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Returns 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." }, { "info": { "name": "GetStackUpdate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/updates/:version", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "version", "value": "", "type": "path", "description": "The stack update version number" } ] }, "docs": "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." }, { "info": { "name": "GetStackPreviews", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/updates/:version/previews", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "version", "value": "", "type": "path", "description": "The stack update version number" }, { "name": "asc", "value": "", "type": "query", "description": "When true, sorts results in ascending chronological order; when false or omitted, sorts in descending order" }, { "name": "page", "value": "", "type": "query", "description": "Page number for paginated results (0-indexed, where 0 returns all results)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results per page (must be >= 1 when page > 0)" } ] }, "docs": "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." }, { "info": { "name": "GetStackUpdateSummary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/updates/:version/summary", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "version", "value": "", "type": "path", "description": "The stack update version number" } ] }, "docs": "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." }, { "info": { "name": "GetUpdateTimeline", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/updates/:version/timeline", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "version", "value": "", "type": "path", "description": "The stack update version number" } ] }, "docs": "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." }, { "info": { "name": "ListUpstreamStackReferences", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/upstreamreferences", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Returns all 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." }, { "info": { "name": "GetStackStarterWorkflow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/workflow", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." } ] }, { "info": { "name": "Insights", "type": "folder" }, "items": [ { "info": { "name": "SearchStacks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/console/orgs/:orgName/stacks/search", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a combined view of IaC-managed stacks and discovered stacks." }, { "info": { "name": "GetUsageSummaryInsightsScans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/insights-scans/summary", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "granularity", "value": "", "type": "query", "description": "Time granularity for grouping usage data. Valid values: 'hourly', 'daily', 'weekly', 'monthly', 'yearly'. Hourly granularity is limited to a 2-day lookback." }, { "name": "lookbackDays", "value": "", "type": "query", "description": "Number of days to look back for usage data. Mutually exclusive with lookbackStart; exactly one must be provided." }, { "name": "lookbackStart", "value": "", "type": "query", "description": "Start of the lookback period as a Unix timestamp (seconds since epoch). Must be within the last year and in the past. Mutually exclusive with lookbackDays; exactly one must be provided." } ] }, "docs": "Returns a summary of Insights scan usage for an organization, grouped by the specified time granularity." }, { "info": { "name": "ListAccounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "count", "value": "", "type": "query", "description": "Number of results to return (default: 100, max: 1000)" }, { "name": "parent", "value": "", "type": "query", "description": "Filter results to child accounts of the specified parent account name (e.g., an AWS organization management account)" }, { "name": "roleID", "value": "", "type": "query", "description": "Filter results to accounts accessible by the specified role" } ] }, "docs": "Lists Insights accounts available to the authenticated user within the specified organization." }, { "info": { "name": "BulkCreateAccounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates multiple Insights accounts in a single operation. Each account is created independently, so a failure to create one account does not prevent other accounts from being created. Returns the list of successfully created accounts and details about any failures. Accounts are created with the same permissions as the single CreateAccount endpoint. For AWS accounts, regional child accounts are created automatically based on the provider configuration." }, { "info": { "name": "ReadAccount", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ] }, "docs": "Gets detailed information for a specific Insights account." }, { "info": { "name": "CreateAccount", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Insights account. An Insights account represents a cloud provider account (e.g., AWS, Azure, OCI) configured for resource discovery." }, { "info": { "name": "UpdateAccount", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing Insights account. Supports partial updates to the ESC environment reference, scan schedule ('none' or 'daily'), and provider-specific configuration such as the list of regions to scan. All request body fields are optional; only provided fields are updated." }, { "info": { "name": "DeleteAccount", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ] }, "docs": "Deletes an Insights account and its associated configuration. This operation is irreversible." }, { "info": { "name": "HeadAccount", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ] }, "docs": "Checks whether an Insights account exists. Returns 204 if found, 404 otherwise." }, { "info": { "name": "ReassignStackOwnership", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/ownership", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes the ownership of the specified Insights account to the provided user. Returns the identity of the previous owner." }, { "info": { "name": "ListPolicyPacksForAccount", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/policy/packs", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" } ] }, "docs": "Returns the policy packs configured to analyze resources in the specified Insights account." }, { "info": { "name": "UpsertResources", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/resources", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates discovered resources in an Insights account. Used by scanners to report resource state." }, { "info": { "name": "ListResourcesWithReferences", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/resources/references", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns discovered resources along with their referenced resources for a batch of resource identifiers." }, { "info": { "name": "ReadResource", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/resources/:resourceTypeAndId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" }, { "name": "resourceTypeAndId", "value": "", "type": "path", "description": "The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id'" } ] }, "docs": "Returns a discovered resource with its current version details." }, { "info": { "name": "ListResourceVersionEdges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/resources/:resourceTypeAndId/edges", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" }, { "name": "resourceTypeAndId", "value": "", "type": "path", "description": "The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id'" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "count", "value": "", "type": "query", "description": "Number of results to return (default: 100, max: 500)" } ] }, "docs": "Returns the relationships (edges) between a discovered resource and other resources in the account." }, { "info": { "name": "ReadResourceWithReferences", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/resources/:resourceTypeAndId/references", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" }, { "name": "resourceTypeAndId", "value": "", "type": "path", "description": "The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id'" } ] }, "docs": "Returns a discovered resource along with its referenced (related) resources." }, { "info": { "name": "ListResourceStackEdges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/resources/:resourceTypeAndId/stack_edges", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" }, { "name": "resourceTypeAndId", "value": "", "type": "path", "description": "The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id' (e.g., 'aws:ec2/instance:Instance::i-1234567890abcdef0')" } ] }, "docs": "Returns the Pulumi stacks that manage the specified discovered resource." }, { "info": { "name": "ListResourceVersions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/resources/:resourceTypeAndId/versions", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" }, { "name": "resourceTypeAndId", "value": "", "type": "path", "description": "The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id'" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "count", "value": "", "type": "query", "description": "Number of results to return (default: 100, max: 500)" } ] }, "docs": "Returns the version history for a discovered resource, showing how its configuration has changed over time." }, { "info": { "name": "ReadResource", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/resources/:resourceTypeAndId/versions/:resourceVersion", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" }, { "name": "resourceTypeAndId", "value": "", "type": "path", "description": "The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id'" }, { "name": "resourceVersion", "value": "", "type": "path", "description": "The specific version number of the discovered resource to retrieve" } ] }, "docs": "Returns a discovered resource with its current or specified version details." }, { "info": { "name": "ListResourceVersionEdges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/resources/:resourceTypeAndId/versions/:resourceVersion/edges", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" }, { "name": "resourceTypeAndId", "value": "", "type": "path", "description": "The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id'" }, { "name": "resourceVersion", "value": "", "type": "path", "description": "The specific version number of the resource to list edges for" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "count", "value": "", "type": "query", "description": "Number of results to return (default: 100, max: 500)" } ] }, "docs": "Returns the relationships (edges) between a discovered resource and other resources in the account." }, { "info": { "name": "UpdateResourceVersionPolicyResults", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/resources/:resourceTypeAndId/versions/:resourceVersion/policy/results", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" }, { "name": "resourceTypeAndId", "value": "", "type": "path", "description": "The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id'" }, { "name": "resourceVersion", "value": "", "type": "path", "description": "The specific version number of the discovered resource to update policy results for" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the policy evaluation results for a specific version of a discovered resource." }, { "info": { "name": "ReadScanStatus", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/scan", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ] }, "docs": "Returns the status of the most recent scan for an Insights account." }, { "info": { "name": "ScanAccount", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/scan", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts a resource discovery scan for an Insights account. For parent accounts, triggers scans across all child accounts." }, { "info": { "name": "CancelScan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/scan/cancel", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ] }, "docs": "Cancels a running resource discovery scan for an Insights account." }, { "info": { "name": "PauseScheduledScans", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/scan/pause", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ] }, "docs": "PauseScheduledScans pauses execution of future scheduled scans for an Insights account." }, { "info": { "name": "ResumeScheduledScans", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/scan/resume", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ] }, "docs": "ResumeScheduledScans resumes execution of future scheduled scans for an Insights account." }, { "info": { "name": "ReadScheduledScanSettings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/scan/settings", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ] }, "docs": "Returns the scheduled scan configuration for an Insights account, including scan frequency and schedule details." }, { "info": { "name": "UpdateScheduledScanSettings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/scan/settings", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the scheduled scan configuration for an Insights account, such as scan frequency and schedule." }, { "info": { "name": "ListScanStatus", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/scans", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results per page (default: 100, max: 1000)" } ] }, "docs": "Returns the scan history for an Insights account, including child accounts for parent accounts." }, { "info": { "name": "GetScan", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/scans/:scanId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" }, { "name": "scanId", "value": "", "type": "path", "description": "The scan identifier" } ] }, "docs": "Returns details for a specific Insights scan, including its status, timestamps, and resource counts." }, { "info": { "name": "GetScanLogs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/scans/:scanId/logs", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" }, { "name": "scanId", "value": "", "type": "path", "description": "The scan identifier" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results. Used when the 'job' parameter is not provided." }, { "name": "count", "value": "", "type": "query", "description": "Number of log entries to return (must be between 1 and 500). Used when the 'job' parameter is not provided." }, { "name": "job", "value": "", "type": "query", "description": "When provided, switches to step-based log retrieval. Specifies the job number whose step logs to fetch." }, { "name": "offset", "value": "", "type": "query", "description": "Byte offset within the step's log output. Used with the 'job' and 'step' parameters." }, { "name": "step", "value": "", "type": "query", "description": "Step number within the specified job. Used with the 'job' parameter." } ] }, "docs": "Returns log output for a specific Insights scan. Supports two modes: when the 'job' parameter is provided, returns step-level logs with job/step offsets; otherwise, uses continuationToken and count for paginated log retrieval." }, { "info": { "name": "GetInsightAccountTags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ] }, "docs": "Returns all tags for an Insights account as a key-value map." }, { "info": { "name": "SetInsightAccountTags", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Atomically replaces all tags for an Insights account with the provided key-value pairs. For AWS parent accounts, tag changes cascade to all child accounts." }, { "info": { "name": "ListInsightsAccountTeams", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/teams", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" } ] }, "docs": "Returns the teams that have been granted access to an Insights account." }, { "info": { "name": "UpdateTeamInsightsAccountPermissions", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/preview/insights/:orgName/accounts/:accountName/teams/:teamName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "accountName", "value": "", "type": "path", "description": "The Insights account name" }, { "name": "teamName", "value": "", "type": "path", "description": "The team name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the permissions that a team has on an Insights account." }, { "info": { "name": "GetDiscoveredProject", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/discovered-stacks/:projectName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The discovered project name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Opaque token for fetching the next page of stacks" } ] }, "docs": "Returns details for a discovered project, including its discovered stacks. Results are paginated; use the continuationToken from the response to fetch subsequent pages." }, { "info": { "name": "GetDiscoveredStack", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/discovered-stacks/:projectName/:stackName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The discovered project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The discovered stack name" } ] }, "docs": "Returns details for a single discovered stack." }, { "info": { "name": "UpsertResourceMigrationAnnotation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/preview/insights/:orgName/discovered-stacks/:projectName/:stackName/migration", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The discovered project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The discovered stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a migration annotation on a discovered resource. The resource is identified by its URN in the request body. At least one of note or statusOverride must be non-empty; requests with both empty are rejected with 400. The statusOverride, if provided, must be Migrated or NotApplicable." }, { "info": { "name": "DeleteResourceMigrationAnnotation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/preview/insights/:orgName/discovered-stacks/:projectName/:stackName/migration", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The discovered project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The discovered stack name" }, { "name": "resourceUrn", "value": "", "type": "query", "description": "URN of the resource to remove the annotation from" } ] }, "docs": "Removes a migration annotation from a discovered resource. The resource is identified by its URN passed as a query parameter." }, { "info": { "name": "ListDiscoveredStackResources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/discovered-stacks/:projectName/:stackName/resources", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The discovered project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The discovered stack name" }, { "name": "compareTo", "value": "", "type": "query", "description": "Pulumi stack to compare against in project/stack format. Must be in the same org." } ] }, "docs": "Returns the list of resources in a discovered stack, each annotated with a migrationStatus. When compareTo is provided, resource identities are matched against the target Pulumi stack." }, { "info": { "name": "GenerateImportCode", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/insights/:orgName/import/code/generate", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates Pulumi code in the specified language to import discovered resources into a Pulumi stack." }, { "info": { "name": "AcceptInsightsBilling", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/preview/insights/:orgName/insightstrial/accept", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Accepts Insights billing charges for the specified organization, enabling metered billing for resource discovery." }, { "info": { "name": "TerminateInsightsTrial", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/preview/insights/:orgName/insightstrial/deny", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Terminates the Insights trial for the organization and removes all associated accounts." }, { "info": { "name": "GetInsightsTrialSummary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/insights/:orgName/insightstrial/summary", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns a summary of the organization's Insights trial usage, including resource counts and remaining trial capacity." }, { "info": { "name": "UpdateStackPolicyResults", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/preview/insights/:orgName/policy/stacks/:projectName/:stackName/updates/:version/results", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "version", "value": "", "type": "path", "description": "The stack update version number identifying a specific Pulumi update operation" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the policy evaluation results for a specific stack update version." } ] }, { "info": { "name": "Deployments", "type": "folder" }, "items": [ { "info": { "name": "GetPulumiDeployExecutor", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/deployments/executor" }, "docs": "Streams the Linux/AMD64 Pulumi Deployments executor binary to the requester. The executor is the component that runs inside a deployment container and executes the actual Pulumi operations. The binary is retrieved from the Docker image/filesystem and proxied through the service to control access. This API is for internal use by workflow runners and requires valid credentials." }, { "info": { "name": "PollDeploymentsQueue", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/deployments/poll" }, "docs": "Polls the Pulumi Deployments queue for available work to execute. This endpoint is used by self-hosted deployment agents running in agent pools to pick up queued deployment jobs. Returns 200 with the next available deployment's workflow definition if work is available, or 204 No Content if the queue is empty. Agents should poll this endpoint repeatedly. Authenticated using an agent pool secret rather than a user access token." }, { "info": { "name": "GetDeploymentsStatus", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/deployments/:deploymentId/status", "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment identifier" } ] }, "docs": "Returns the current execution status of a Pulumi Deployments run. This endpoint is used by self-hosted deployment agents running in agent pools to check whether a deployment is still active. Authenticated using an agent pool secret rather than a user access token." }, { "info": { "name": "ListOrgDeployments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/deployments", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "asc", "value": "", "type": "query", "description": "Sort in ascending order when true (default false)" }, { "name": "page", "value": "", "type": "query", "description": "Page number (min 1, default 1)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Results per page (1-100, default 10)" }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort results by" } ] }, "docs": "Returns a paginated list of all Pulumi Deployments executions across an organization, filtered to only include deployments for stacks the requesting user has access to. The response includes each deployment's ID, status, version, creation time, the requesting user, project and stack names, Pulumi operation type, job details, and associated update results. Use 'page' (minimum 1, default 1) and 'pageSize' (1-100, default 10) for pagination, 'sort' to specify the sort field, and 'asc' to control so" }, { "info": { "name": "OrgDeploymentsMetadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/deployments/metadata", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns metadata about the organization's Pulumi Deployments state. The response includes the overall pause status, a list of individually paused stacks (as stack references like `project/stack`), the configured concurrency limit (maximum number of concurrent deployments), and deployment counts broken down by status (`notStarted`, `accepted`, `running`, `failed`, `succeeded`, `skipped`, and `total`). This endpoint is useful for monitoring deployment health and capacity across an organization." }, { "info": { "name": "PauseOrgDeployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/deployments/pause", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Pauses all future Pulumi Deployments executions across an entire organization. While paused, new deployments can still be queued and currently executing deployments will continue to run to completion. However, queued deployments will not be picked up for execution until deployments are resumed. This provides a safety mechanism to temporarily halt all deployment activity across the organization, for example during maintenance windows or incident response. Requires organization administrator permi" }, { "info": { "name": "ResumeOrgDeployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/deployments/resume", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Resumes Pulumi Deployments executions for an organization that was previously paused via PauseOrgDeployments. Any queued deployments that accumulated while the organization was paused will begin processing according to the organization's concurrency limits. Requires organization administrator permissions." }, { "info": { "name": "GetUsageSummaryDeployCompute", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/deployments/summary", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "granularity", "value": "", "type": "query", "description": "Time granularity for the summary (e.g. 'daily', 'hourly')" }, { "name": "lookbackDays", "value": "", "type": "query", "description": "Number of days to look back from the current date" }, { "name": "lookbackStart", "value": "", "type": "query", "description": "Start of the lookback period (Unix timestamp)" } ] }, "docs": "Retrieves a summary of Pulumi Deployments compute usage (deployment minutes) for an organization. The response provides aggregated deployment minute consumption over the specified time period. Use the 'granularity' parameter to control time bucketing (e.g. 'daily' or 'hourly'), and either 'lookbackDays' (number of days from the current date) or 'lookbackStart' (a Unix timestamp) to define the reporting window. Returns 204 No Content if no usage data is available for the specified period." }, { "info": { "name": "GetDeployUsageReport", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/deployments/usagereport", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "lookbackDays", "value": "", "type": "query", "description": "Number of days to look back" } ] }, "docs": "Retrieves raw deployment usage records for self-hosted Pulumi Cloud customers to self-report deployment consumption. Returns aggregated deployment usage records for the specified organization. The 'lookbackDays' query parameter controls how far back in time to retrieve records. This endpoint is primarily used by self-hosted customers for usage reporting and billing reconciliation purposes." }, { "info": { "name": "ListStackDeploymentsHandlerV2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "asc", "value": "", "type": "query", "description": "Sort in ascending order when true (default false)" }, { "name": "page", "value": "", "type": "query", "description": "Page number (min 1, default 1)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Results per page (1-100, default 10)" }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort results by" } ] }, "docs": "Returns a paginated list of Pulumi Deployments executions for a specific stack. The response includes each deployment's ID, status, version, creation and modification timestamps, the requesting user, Pulumi operation type, job details with step-level progress, and associated stack update results. Use 'page' (minimum 1, default 1) and 'pageSize' (1-100, default 10) for pagination, 'sort' to specify the sort field, and 'asc' to control sort direction (default descending). The response also include" }, { "info": { "name": "CreateAPIDeploymentHandlerV2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates a new Pulumi Deployments execution for a stack. Pulumi Deployments is a managed service that executes Pulumi operations (update, preview, refresh, or destroy) in a secure, hosted environment.\n\n**Important:** The stack must already exist before a deployment can be created for it.\n\nThe `operation` field is required and accepts: `update`, `preview`, `refresh`, or `destroy`. Three usage modes are supported:\n1. **Stack settings only:** Send `{\"operation\": \"update\"}` to use the stack's saved" }, { "info": { "name": "ClearProjectCache", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/cache", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Clears all cached dependency and build artifacts associated with the project for Pulumi Deployments. The deployment cache stores dependencies and other artifacts between deployment runs to speed up execution. Use this endpoint to force a clean build on the next deployment, for example when cached dependencies become stale or corrupted." }, { "info": { "name": "GetPresignedCacheURL", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/cache/url", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a presigned URL for saving or restoring the Pulumi Deployments dependency cache. The cache stores build artifacts and dependencies between deployment runs to speed up execution. The request body must specify a method (PUT to upload a cache archive, or GET to download one) and a non-empty cache key identifying the cached content. The returned presigned URL can be used directly for the corresponding HTTP operation against the object store without additional authentication." }, { "info": { "name": "CreateScheduledDriftDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/drift/schedules", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a drift detection schedule for a stack using Pulumi Deployments. Drift detection identifies divergence between the declared infrastructure state in your Pulumi program and the actual state of resources in the cloud provider. The 'scheduleCron' field accepts a cron expression defining when drift detection should run (e.g. '0 */4 * * *' for every 4 hours). When 'autoRemediate' is set to true, a remediation update is automatically triggered to bring resources back into alignment with the de" }, { "info": { "name": "UpdateScheduledDriftDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/drift/schedules/:scheduleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of an existing drift detection schedule. The request body can modify the cron expression controlling when drift detection runs and the autoRemediate flag that determines whether detected drift is automatically corrected by running an update operation. Auto-remediation requires a Business Critical subscription. Only future executions are affected; past drift detection runs are not modified." }, { "info": { "name": "StackDeploymentsMetadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/metadata", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Returns metadata about the Pulumi Deployments state for a specific stack. The response distinguishes the source of any pause:\n\n- `paused`: overall pause status (true if either stack or org is paused)\n- `stackPaused`: whether the stack itself is paused\n- `organizationPaused`: whether the containing organization is paused\n\nThis is useful for determining whether new deployments will be processed or held in the queue." }, { "info": { "name": "PauseStackDeployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/pause", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Pauses all future Pulumi Deployments executions for a specific stack. While paused, new deployments can still be queued and currently executing deployments will continue to run to completion. However, queued deployments will not be picked up for execution until deployments are resumed. The stack must have deployment settings configured before it can be paused. Requires stack deployment create permissions. Use the ResumeStackDeployments endpoint to resume processing." }, { "info": { "name": "ResumeStackDeployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/resume", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Resumes Pulumi Deployments executions for a stack that was previously paused via PauseStackDeployments. Any queued deployments that accumulated while the stack was paused will begin processing. The stack must have deployment settings configured. Requires stack deployment create permissions." }, { "info": { "name": "ListScheduledDeployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Returns all scheduled deployment actions configured for a stack. The response includes all schedule types: custom deployment schedules (cron-based recurring or one-time), drift detection schedules, and TTL (time-to-live) schedules. Each schedule in the response contains its ID, type, configuration (cron expression or timestamp), current status (active or paused), and the deployment request that will be executed on each run." }, { "info": { "name": "CreateScheduledDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a custom deployment schedule for a stack using Pulumi Deployments. Custom schedules allow you to automate recurring or one-time Pulumi operations on a stack. The request must include exactly one of 'scheduleCron' (a cron expression for recurring executions, e.g. '0 */4 * * *' for every 4 hours) or 'scheduleOnce' (an ISO 8601 timestamp for a one-time execution). The 'request' field contains the deployment configuration that will be executed on each scheduled run, including the Pulumi oper" }, { "info": { "name": "ReadScheduledDeployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules/:scheduleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ] }, "docs": "Retrieves the full configuration and metadata for a specific scheduled deployment action. The response includes the schedule's ID, type (custom, drift, or TTL), timing configuration (cron expression or one-time timestamp), current status (active or paused), the deployment request that will be executed, and any type-specific fields such as autoRemediate for drift schedules or deleteAfterDestroy for TTL schedules." }, { "info": { "name": "UpdateScheduledDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules/:scheduleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of an existing custom deployment schedule. The request body can modify the timing (cron expression for recurring schedules or ISO 8601 timestamp for one-time schedules) and the deployment request that will be executed on each future run, including the Pulumi operation type and settings overrides. Only future executions are affected; past executions are not modified. The stack must have deployment settings configured." }, { "info": { "name": "DeleteScheduledDeployment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules/:scheduleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ] }, "docs": "Permanently deletes a scheduled deployment action from a stack. This removes the schedule configuration entirely and cannot be undone. The schedule will no longer execute any future runs. This endpoint is used for all schedule types (custom, drift detection, and TTL). To temporarily stop a schedule without deleting it, use the pause endpoint instead." }, { "info": { "name": "ListScheduledDeploymentHistory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules/:scheduleID/history", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ] }, "docs": "Returns the execution history for a specific scheduled deployment action. The response includes a chronological list of past schedule invocations and their outcomes, such as whether the triggered deployment succeeded, failed, or was skipped. This is useful for monitoring the reliability and results of recurring deployments, drift detection runs, or TTL schedule executions." }, { "info": { "name": "PauseScheduledDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules/:scheduleID/pause", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ] }, "docs": "Temporarily suspends future executions of a scheduled deployment action without deleting the schedule configuration. The schedule remains configured and can be reactivated at any time using the ResumeScheduledDeployment endpoint. This is useful for temporarily halting recurring schedules (drift detection, TTL, or custom) during maintenance periods or when troubleshooting issues." }, { "info": { "name": "ResumeScheduledDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/schedules/:scheduleID/resume", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ] }, "docs": "Reactivates a previously paused scheduled deployment action. After resuming, the schedule will continue executing according to its configured timing (cron expression for recurring schedules, or at the scheduled timestamp for one-time schedules). This works for all schedule types: custom deployment schedules, drift detection schedules, and TTL schedules." }, { "info": { "name": "GetDeploymentSettings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/settings", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Retrieves the Pulumi Deployments configuration for a specified stack. The response includes all saved deployment settings: source context (git repository URL, branch, and directory), operation context (environment variables, pre-run commands, OIDC provider configuration), executor context (deployment executor configuration), GitHub integration settings (repository, paths, deployment triggers), and cache options for dependency caching between runs. These settings serve as the baseline configurati" }, { "info": { "name": "PatchDeploymentSettings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/settings", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates Pulumi Deployments settings for a stack using a merge operation. If no settings exist, they are created. If settings already exist, the request body is merged with the current settings using the following logic: for each property, start with the current value, remove it if the patch specifies null, or merge the new non-null value with the existing one. Non-object properties (strings, numbers, booleans) are replaced entirely. Settings include source context (git repository URL," }, { "info": { "name": "ReplaceDeploymentSettings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/settings", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Fully replaces the Pulumi Deployments settings for a stack. Unlike the PATCH endpoint (PatchDeploymentSettings) which merges changes, this endpoint replaces all settings with the provided values. Any previously configured settings not included in the request body will be removed. Settings include source context (git repository URL, branch, directory), operation context (environment variables, pre-run commands, OIDC configuration), executor context, GitHub integration settings, and cache options." }, { "info": { "name": "DeleteDeploymentSettings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/settings", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Removes all Pulumi Deployments settings for a stack, including source context, operation context, executor context, GitHub integration settings, and cache options. After deletion, the stack can no longer run deployments until new settings are configured. Any active schedules (drift detection, TTL, or custom) associated with the stack may also be affected." }, { "info": { "name": "EncryptDeploymentSettingsSecret", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/settings/encrypt", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Encrypts a plaintext secret value for secure storage in Pulumi Deployments settings. Use this endpoint to encrypt sensitive values such as cloud provider credentials, API keys, or other secrets before including them in deployment settings (e.g. as environment variables in operationContext). The encrypted value can then be safely stored in the deployment settings and will be decrypted at deployment execution time. The request body must contain a non-empty plaintext value to encrypt." }, { "info": { "name": "CreateScheduledTTLDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/ttl/schedules", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a TTL (time-to-live) schedule for a stack using Pulumi Deployments. TTL schedules automatically destroy a stack's cloud resources at a specified expiration time, which is useful for temporary or ephemeral infrastructure that should be cleaned up after a defined period. The 'timestamp' field must be an ISO 8601 formatted date-time (e.g. '2024-12-31T00:00:00.000Z') specifying when the destroy operation should execute. When 'deleteAfterDestroy' is set to true, the stack itself is also remov" }, { "info": { "name": "UpdateScheduledTTLDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/ttl/schedules/:scheduleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of an existing TTL (time-to-live) schedule. The request body can modify the destruction timestamp (ISO 8601 format) and the deleteAfterDestroy flag that controls whether the stack is also removed from Pulumi Cloud after its resources are successfully destroyed. The timestamp field is required and must be set to a valid future date-time." }, { "info": { "name": "GetDeployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/version/:version", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "version", "value": "", "type": "path", "description": "The deployment version number" } ] }, "docs": "Retrieves detailed information about a specific Pulumi Deployments execution by its version number within the stack. This is an alternative to fetching by deployment ID and returns the same response structure: deployment status, creation and modification timestamps, the user who requested the deployment, the Pulumi operation type, job details with step-level progress, and any associated stack update results." }, { "info": { "name": "GetDeployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/:deploymentId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment identifier" } ] }, "docs": "Retrieves detailed information about a specific Pulumi Deployments execution by its deployment ID. The response includes the deployment's current status, creation and modification timestamps, version number, the user who requested the deployment, the Pulumi operation type (update, preview, refresh, or destroy), and detailed job information. Each job contains an array of steps with their individual statuses (not-started, running, succeeded, or failed), start times, and last update timestamps. The" }, { "info": { "name": "CancelDeployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/:deploymentId/cancel", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment identifier" } ] }, "docs": "Terminates an in-progress Pulumi Deployments execution for a specific stack. If the deployment is currently running, it is stopped immediately. If the deployment is queued but has not yet started, it is removed from the queue.\n\n**Warning:** Canceling a deployment is a dangerous action and may leave the stack in an inconsistent state if the deployment is canceled during the execution of a Pulumi operation.\n\nNote that this serves two endpoints:\n- /{orgName}/{projectName}/{stackName}/deployments/{d" }, { "info": { "name": "GetDeploymentLogs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/:deploymentId/logs", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment identifier" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for streaming logs; use nextToken from the previous response to fetch subsequent log entries" }, { "name": "count", "value": "", "type": "query", "description": "Number of log lines to return (1-499, default 100)" }, { "name": "job", "value": "", "type": "query", "description": "Zero-based job index to retrieve logs for" }, { "name": "offset", "value": "", "type": "query", "description": "Zero-based line offset within the step logs" }, { "name": "step", "value": "", "type": "query", "description": "Zero-based step index within the specified job" } ] }, "docs": "Retrieves execution logs for a Pulumi Deployments run. Supports two retrieval modes: streaming mode and step mode. In streaming mode, omit job/step parameters and use the continuationToken to incrementally fetch logs from the beginning through completion. Each response includes a nextToken field; continue requesting with this token until nextToken is absent, indicating all logs have been retrieved. In step mode, specify job and step indices to retrieve logs for a specific step within a specific " }, { "info": { "name": "GetDeploymentUpdates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/deployments/:deploymentId/updates", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment identifier" } ] }, "docs": "Retrieves all stack updates (program updates) associated with a specific Pulumi Deployments execution. A single deployment may produce one or more stack updates depending on the operation performed. Each update in the response includes details such as the update ID, version, start and end times, result status, and resource changes. This is useful for correlating deployment executions with their resulting infrastructure changes." }, { "info": { "name": "ListDriftRuns", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/drift/runs", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" }, { "name": "page", "value": "", "type": "query", "description": "Page number (min 1, default 1)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Results per page (1-100, default 10)" } ] }, "docs": "Returns a paginated list of all drift detection runs for a stack. Each drift run represents a scheduled or manually triggered drift detection execution and includes details about whether drift was detected and any remediation actions taken. Use the 'page' (minimum 1, default 1) and 'pageSize' (1-100, default 10) query parameters for pagination." }, { "info": { "name": "GetStackDriftStatus", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/stacks/:orgName/:projectName/:stackName/drift/status", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "stackName", "value": "", "type": "path", "description": "The stack name" } ] }, "docs": "Retrieves the current drift detection status and associated metadata for a stack. Drift occurs when the actual state of cloud resources diverges from the state declared in the Pulumi program. The response indicates whether drift has been detected, when the last drift check was performed, and details about any detected differences. This is used in conjunction with drift detection schedules to monitor infrastructure compliance." } ] }, { "info": { "name": "CloudSetup", "type": "folder" }, "items": [ { "info": { "name": "AWSSetup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/cloudsetup/:orgName/aws/setup", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets up AWS infrastructure using provided static credentials" }, { "info": { "name": "AWSSSOListAccounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/cloudsetup/:orgName/aws/sso/accounts", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "region", "value": "", "type": "query", "description": "The AWS region" }, { "name": "sessionId", "value": "", "type": "query", "description": "The SSO session identifier" } ] }, "docs": "Lists AWS accounts accessible with the provided session" }, { "info": { "name": "AWSSSOInitiate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/cloudsetup/:orgName/aws/sso/initiate", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the AWS SSO flow" }, { "info": { "name": "AWSSSOSetup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/cloudsetup/:orgName/aws/sso/setup", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets up AWS infrastructure and ESC environments using AWS SSO" }, { "info": { "name": "AzureListAccounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/cloudsetup/:orgName/oauth/azure/accounts", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "armSessionId", "value": "", "type": "query", "description": "The Azure ARM session identifier" } ] }, "docs": "Lists Azure subscriptions accessible with the provided ARM session" }, { "info": { "name": "AzureSetup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/cloudsetup/:orgName/oauth/azure/setup", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets up Azure infrastructure and ESC environments using OAuth credentials" }, { "info": { "name": "CompleteOAuth", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/cloudsetup/:orgName/oauth/complete", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Completes OAuth flow by exchanging authorization code for access token" }, { "info": { "name": "GCPListAccounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/cloudsetup/:orgName/oauth/gcp/accounts", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "oauthSessionId", "value": "", "type": "query", "description": "The OAuth session identifier" } ] }, "docs": "Lists GCP projects accessible with the provided oauth session" }, { "info": { "name": "GCPSetup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/cloudsetup/:orgName/oauth/gcp/setup", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets up GCP infrastructure using OAuth credentials" }, { "info": { "name": "InitiateOAuth", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/cloudsetup/:orgName/oauth/initiate", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates OAuth flow for a given cloud provider" } ] }, { "info": { "name": "Environments", "type": "folder" }, "items": [ { "info": { "name": "ListEnvironments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments", "params": [ { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "includeReferrerMetadata", "value": "", "type": "query", "description": "Whether to include referrer metadata. Defaults to false." }, { "name": "maxResults", "value": "", "type": "query", "description": "Maximum number of results for pagination" }, { "name": "organization", "value": "", "type": "query", "description": "Filter results to this organization name" } ] }, "docs": "Returns a paginated list of all Pulumi ESC environments accessible to the authenticated user across all organizations they belong to. Each entry includes the organization, project, environment name, and creation/modification timestamps. Use the organization query parameter to filter results to a specific organization. Use continuationToken for pagination through large result sets." }, { "info": { "name": "ListOrgEnvironments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "includeReferrerMetadata", "value": "", "type": "query", "description": "Whether to include referrer metadata. Defaults to false." }, { "name": "maxResults", "value": "", "type": "query", "description": "Maximum number of results for pagination" }, { "name": "roleID", "value": "", "type": "query", "description": "The custom role to use for listing environments" } ] }, "docs": "Returns a paginated list of all Pulumi ESC environments within a specific organization. Each entry includes the project, environment name, and creation/modification timestamps. Results are scoped to the organization specified in the URL path. Use continuationToken for pagination through large result sets." }, { "info": { "name": "CreateEnvironment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "ListDeletedEnvironments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/restore", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" } ] }, "docs": "Returns a paginated list of soft-deleted Pulumi ESC environments within an organization that are still within the retention window and eligible for restoration. Use the continuationToken query parameter for pagination. Deleted environments can be restored via the RestoreEnvironment endpoint." }, { "info": { "name": "RestoreEnvironment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/esc/environments/:orgName/restore", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restores a previously deleted Pulumi ESC environment within an organization. The request body specifies the environment to restore by its project and name. The environment must have been deleted within the retention window and not yet permanently purged. Returns 204 on success with no response body. Returns 404 if the deleted environment cannot be found." }, { "info": { "name": "ListAllEnvironmentTags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns a map of all unique tag names and their distinct values across all Pulumi ESC environments in the organization. The response is a map where each key is a tag name and the value is a list of all distinct values for that tag across all environments. This is useful for building tag-based filtering or discovery UIs." }, { "info": { "name": "CheckYAML", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/yaml/check", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "showSecrets", "value": "", "type": "query", "description": "Whether to show secret values in plaintext" } ] }, "docs": "Checks a raw YAML environment definition for errors without creating or modifying any environment. The YAML definition is provided in the request body and validated for correctness, including imports, provider configurations, function invocations, and interpolation expressions. When the showSecrets query parameter is set to true, secret values are returned in plaintext in the response. This is useful for validating environment definitions before applying them." }, { "info": { "name": "OpenYAML", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/yaml/open", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "duration", "value": "", "type": "query", "description": "The session duration, using Go time units: ns, us, ms, s, m, h (e.g. '2h')" } ] }, "docs": "Opens an anonymous Pulumi ESC environment from a raw YAML definition provided in the request body, fully resolving all dynamic values, provider integrations, and secrets. Unlike OpenEnvironment, this does not require a pre-existing environment to be stored. The duration parameter specifies how long the session remains valid using Go duration format. Returns an OpenEnvironmentResponse containing the session ID. Use the session ID with ReadAnonymousOpenEnvironment to retrieve the resolved values." }, { "info": { "name": "ReadAnonymousOpenEnvironment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/yaml/open/:openSessionID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "openSessionID", "value": "", "type": "path", "description": "The session ID returned from the open environment operation" }, { "name": "property", "value": "", "type": "query", "description": "A dot-separated path to a specific property to retrieve from the environment" } ] }, "docs": "Reads the fully resolved values from an anonymous open environment session that was created via the OpenYAML endpoint. The openSessionID path parameter must match a valid, non-expired session. The optional property query parameter accepts a dot-separated path to retrieve a specific nested value instead of the entire resolved environment (e.g., 'aws.credentials.accessKeyId'). The response contains the resolved configuration values with secrets decrypted." }, { "info": { "name": "ReadEnvironment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Returns the YAML definition of a Pulumi ESC environment. The response is in application/x-yaml format and includes the environment's imports, values, provider configurations, and function invocations. Secrets remain in their encrypted form (use DecryptEnvironment to see plaintext secrets, or OpenEnvironment to fully resolve all dynamic values). When a version path parameter is provided, returns the definition for that specific revision." }, { "info": { "name": "UpdateEnvironment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Validates and updates the YAML definition of a Pulumi ESC environment. The request body must contain the complete environment definition in application/x-yaml format, including imports, values, provider configurations, and function invocations. Each successful update creates a new immutable revision in the environment's version history. Supports optimistic concurrency control via ETag/If-Match headers; returns 409 if the environment has been modified since it was last read." }, { "info": { "name": "DeleteEnvironment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Permanently deletes a Pulumi ESC environment and all of its revision history, tags, and associated configuration. This operation is blocked if deletion protection is enabled on the environment (see PatchEnvironmentSettings). Enterprise and Business Critical edition organizations may be able to restore deleted environments within a retention window. Returns 409 if the environment is deletion-protected or has been modified since it was last read." }, { "info": { "name": "HeadEnvironment", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Returns the ETag header for a Pulumi ESC environment without returning the full definition body. This is used for lightweight existence checks and for obtaining the current ETag value for optimistic concurrency control. The ETag should be included in subsequent update requests via the If-Match header to prevent concurrent modification conflicts. Returns 404 if the environment does not exist." }, { "info": { "name": "CheckEnvironment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/check", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "showSecrets", "value": "", "type": "query", "description": "Whether to show secret values in plaintext" } ] }, "docs": "Checks a Pulumi ESC environment definition for errors without applying changes. This validates the YAML definition including imports, provider configurations, function invocations (fn::open, fn::secret, etc.), and interpolation expressions. When the showSecrets query parameter is set to true, secret values are returned in plaintext in the response. The response includes any diagnostics or validation errors found in the environment definition. Supports optimistic concurrency control via ETag head" }, { "info": { "name": "CloneEnvironment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/clone", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a duplicate of a Pulumi ESC environment in a new project and/or under a new name. The request body specifies the destination project and environment name, along with options to control what is preserved during the clone: preserveAccess retains permission settings, preserveHistory retains the full revision history, preserveEnvironmentTags retains environment-level tags, and preserveRevisionTags retains version-specific tags. Environments cannot be renamed directly, so cloning is the mecha" }, { "info": { "name": "DecryptEnvironment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/decrypt", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Reads the YAML definition for a Pulumi ESC environment with all static secrets decrypted and shown in plaintext. Unlike the standard ReadEnvironment endpoint which returns secrets in their encrypted form, this endpoint resolves fn::secret values to their plaintext representations. The response is returned in application/x-yaml format. This does not resolve dynamic provider values (fn::open); use OpenEnvironment for full resolution. Requires environment open permission." }, { "info": { "name": "DecryptEnvironmentSecrets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/decrypt-secrets", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Decrypts encrypted secret values in a Pulumi ESC environment definition. Takes an environment definition containing encrypted secrets and returns the same definition with those values decrypted to plaintext. This is useful for inspecting or migrating environment definitions that contain fn::secret values. Requires environment open permission. Returns 413 if the request content exceeds the maximum allowed size." }, { "info": { "name": "CreateEnvironmentDraft", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/drafts", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "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." }, { "info": { "name": "ReadEnvironmentDraft", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/drafts/:changeRequestID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request ID" }, { "name": "revision", "value": "", "type": "query", "description": "The environment revision number to target" } ] }, "docs": "Reads the YAML definition for a draft version of a Pulumi ESC environment. Drafts are proposed changes created as part of the approvals workflow. The draft is identified by the changeRequestID path parameter. An optional revision query parameter can target a specific base revision. The response is returned in application/x-yaml format. Requires the Approvals feature to be enabled." }, { "info": { "name": "UpdateEnvironmentDraft", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/drafts/:changeRequestID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request ID" } ] }, "docs": "Updates the YAML definition of an existing draft change request for a Pulumi ESC environment. The draft is identified by the changeRequestID path parameter. The request body contains the updated YAML definition. Returns a ChangeRequestRef on success. Requires the Approvals feature to be enabled for the organization." }, { "info": { "name": "OpenEnvironmentDraft", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/drafts/:changeRequestID/open", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request ID" }, { "name": "duration", "value": "", "type": "query", "description": "The session duration, using Go time units: ns, us, ms, s, m, h (e.g. '2h')" }, { "name": "revision", "value": "", "type": "query", "description": "The environment revision number to target" } ] }, "docs": "Opens a draft version of a Pulumi ESC environment, fully resolving all dynamic values, provider integrations, and secrets for the proposed changes. The duration parameter specifies how long the open session remains valid using Go duration format (e.g., '2h', '30m'). An optional revision parameter can target a specific base revision. Returns an OpenEnvironmentResponse containing the session ID for subsequent reads. Requires the Approvals feature." }, { "info": { "name": "EncryptEnvironmentSecrets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/encrypt-secrets", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Encrypts plaintext secret values in a Pulumi ESC environment definition. Takes an environment definition containing plaintext secrets and returns the same definition with those values encrypted using the environment's encryption key. This is useful for preparing environment definitions that contain sensitive values before storing or updating them. Returns 413 if the request content exceeds the maximum allowed size." }, { "info": { "name": "ListWebhooks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/hooks", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Returns a list of all webhooks configured for a Pulumi ESC environment. Each webhook entry includes its name, destination URL, event filters, format, and active status. Webhooks enable external services to be notified of environment events such as updates and opens." }, { "info": { "name": "CreateWebhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/hooks", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetWebhook", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/hooks/:hookName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ] }, "docs": "Returns the configuration and status of a single webhook for a Pulumi ESC environment. The webhook is identified by its name in the URL path. The response includes the webhook's destination URL, event filters, format, and active status. Returns 404 if the webhook does not exist." }, { "info": { "name": "UpdateWebhook", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/hooks/:hookName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of an existing webhook on a Pulumi ESC environment. The webhook is identified by its name in the URL path. The request body contains the updated webhook configuration including destination URL, event filters, format, and active status. Returns the updated WebhookResponse on success. Returns 400 if an invalid format is specified." }, { "info": { "name": "DeleteWebhook", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/hooks/:hookName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ] }, "docs": "Deletes a webhook from a Pulumi ESC environment. The webhook is identified by its name in the URL path. After deletion, the external service will no longer receive notifications for environment events. Returns 204 on success with no response body." }, { "info": { "name": "GetWebhookDeliveries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/hooks/:hookName/deliveries", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ] }, "docs": "Returns a list of recent delivery attempts for a specific webhook on a Pulumi ESC environment. Each delivery record includes the HTTP status code, response body, timestamp, and whether the delivery was successful. This is useful for debugging webhook integration issues and verifying that events are being received." }, { "info": { "name": "RedeliverWebhookEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/hooks/:hookName/deliveries/:event/redeliver", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" }, { "name": "event", "value": "", "type": "path", "description": "The webhook delivery event ID to redeliver" } ] }, "docs": "Triggers the Pulumi Service to redeliver a specific event to a webhook on a Pulumi ESC environment. This is useful for resending events that the webhook endpoint failed to process on the initial delivery attempt (e.g., due to temporary downtime or errors). The event is identified by its delivery event ID in the URL path. Returns the new WebhookDelivery record for the redelivery." }, { "info": { "name": "PingWebhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/hooks/:hookName/ping", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ] }, "docs": "Sends a test ping event to a webhook on a Pulumi ESC environment to verify that the webhook endpoint is reachable and functioning correctly. This bypasses the normal message queue and issues the request directly to the webhook URL. Returns the WebhookDelivery record containing the HTTP status code and response from the target endpoint." }, { "info": { "name": "GetEnvironmentMetadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/metadata", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Returns metadata for a Pulumi ESC environment, including the calling user's effective permission level (read, open, write, admin), creation and modification timestamps, the environment's project, and other administrative information. This is useful for determining what actions the current user can perform on the environment before attempting those operations." }, { "info": { "name": "OpenEnvironment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/open", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "duration", "value": "", "type": "query", "description": "The session duration, using Go time units: ns, us, ms, s, m, h (e.g. '2h')" } ] }, "docs": "Opens a Pulumi ESC environment, fully resolving all dynamic values, provider integrations (fn::open), interpolation expressions, and secrets. This initiates an access session that evaluates the complete environment definition including all imports. The duration parameter specifies how long the session remains valid using Go duration format (e.g., '2h45m', '300ms'). Returns an OpenEnvironmentResponse containing the session ID and any diagnostics. Use the session ID with ReadOpenEnvironment to ret" }, { "info": { "name": "CreateOpenEnvironmentRequest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/open/request", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "ReadOpenEnvironmentRequest", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/open/request/:changeRequestID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request ID" }, { "name": "revision", "value": "", "type": "query", "description": "The environment revision number to target" } ] }, "docs": "Reads the details of an open environment request that was created as part of the gated opens approval workflow. The request is identified by the changeRequestID path parameter. The response includes the request's status, the requesting user, and approval details. An optional revision query parameter can target a specific environment revision. Requires the Approvals feature to be enabled." }, { "info": { "name": "UpdateOpenEnvironmentRequest", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/open/request/:changeRequestID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing open environment request that was created as part of the gated opens approval workflow. The request is identified by the changeRequestID path parameter. The request body contains the updated open request details, such as approval status. Returns a ChangeRequestRef on success. Requires the Approvals feature to be enabled for the organization." }, { "info": { "name": "ReadOpenEnvironment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/open/:openSessionID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "openSessionID", "value": "", "type": "path", "description": "The session ID returned from the open environment operation" }, { "name": "property", "value": "", "type": "query", "description": "A dot-separated path to a specific property to retrieve from the environment" } ] }, "docs": "Reads the fully resolved values from an open environment session that was created via the OpenEnvironment endpoint. The openSessionID path parameter must match a valid, non-expired session. The optional property query parameter accepts a dot-separated path to retrieve a specific nested value instead of the entire resolved environment (e.g., 'aws.credentials.accessKeyId'). The response contains all resolved configuration values with secrets decrypted and provider-sourced values fully evaluated." }, { "info": { "name": "ReassignEnvironmentOwnership", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/ownership", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes the ownership of the specified environment to the provided user. Returns the identity of the previous owner." }, { "info": { "name": "ListEnvironmentReferrers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/referrers", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "allRevisions", "value": "", "type": "query", "description": "Whether to include all revisions" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "count", "value": "", "type": "query", "description": "Maximum number of results to return" }, { "name": "latestStackVersionOnly", "value": "", "type": "query", "description": "Whether to return only the latest stack version" } ] }, "docs": "Returns a paginated list of entities that reference a Pulumi ESC environment, including other environments that import it and Pulumi stacks that use it in their configuration. The count parameter limits results (range 1-500). Set allRevisions to true to include references across all revisions, and latestStackVersionOnly to true to return only the latest stack version for each referring stack. Use continuationToken for pagination." }, { "info": { "name": "RotateEnvironment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/rotate", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Triggers secret rotation for a Pulumi ESC environment. This evaluates all fn::rotate declarations in the environment definition and rotates the corresponding secrets in their external systems (e.g., rotating database passwords, API keys, or cloud credentials). Requires the secret rotation feature to be enabled for the organization. Returns 409 if the environment has been modified since it was last read." }, { "info": { "name": "ListEnvironmentSecretRotationHistory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/rotate/history", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Returns the secret rotation history for a Pulumi ESC environment. Each entry represents a rotation event where secrets defined with fn::rotate were cycled to new values in their external systems. The response includes timestamps, outcomes, and the rotators involved. Requires the secret rotation feature to be enabled for the organization." }, { "info": { "name": "ListEnvironmentSchedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/schedules", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Returns all scheduled actions configured for a Pulumi ESC environment. Schedules automate recurring operations such as secret rotation. The response includes each schedule's timing configuration, action type, and current status (active or paused)." }, { "info": { "name": "CreateEnvironmentSchedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/schedules", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "ReadEnvironmentSchedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/schedules/:scheduleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule ID" } ] }, "docs": "Returns the details of a specific scheduled action for a Pulumi ESC environment. The schedule is identified by the scheduleID path parameter. The response includes the schedule's timing configuration (cron expression or one-time), the action to perform, and the current status (active or paused)." }, { "info": { "name": "UpdateEnvironmentSchedule", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/schedules/:scheduleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of a scheduled action for a Pulumi ESC environment. The schedule is identified by the scheduleID path parameter. The request body specifies the updated timing and action configuration. Changes take effect for future executions only; any currently running execution is not affected. Returns the updated ScheduledAction on success." }, { "info": { "name": "DeleteEnvironmentSchedule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/schedules/:scheduleID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule ID" } ] }, "docs": "Permanently deletes a scheduled action from a Pulumi ESC environment. This removes the schedule and cancels any future executions. The schedule is identified by its scheduleID. Requires the secret rotation feature to be enabled for the organization." }, { "info": { "name": "ListEnvironmentScheduleHistory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/schedules/:scheduleID/history", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule ID" } ] }, "docs": "Returns the execution history for a specific scheduled action on a Pulumi ESC environment. Each history entry includes the execution timestamp, outcome (success or failure), and any error details. This is useful for monitoring the reliability of automated operations like secret rotation." }, { "info": { "name": "PauseEnvironmentSchedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/schedules/:scheduleID/pause", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule ID" } ] }, "docs": "Pauses a scheduled action on a Pulumi ESC environment, preventing any future executions until the schedule is resumed. The schedule's configuration is preserved and can be reactivated via the ResumeEnvironmentSchedule endpoint. This is useful for temporarily disabling automated operations like secret rotation without deleting the schedule." }, { "info": { "name": "ResumeEnvironmentSchedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/schedules/:scheduleID/resume", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "scheduleID", "value": "", "type": "path", "description": "The schedule ID" } ] }, "docs": "Resumes a previously paused scheduled action on a Pulumi ESC environment, re-enabling future executions. The schedule will continue from its next scheduled time according to its configured timing (cron expression or one-time schedule). The schedule is identified by the scheduleID path parameter." }, { "info": { "name": "GetEnvironmentSettings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/settings", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Returns the current settings for a Pulumi ESC environment, including whether deletion protection is enabled. Deletion protection prevents the environment from being deleted until the setting is explicitly disabled. Settings can be modified via the PatchEnvironmentSettings endpoint." }, { "info": { "name": "PatchEnvironmentSettings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/settings", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "ListEnvironmentTags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "after", "value": "", "type": "query", "description": "Only return results after this value" }, { "name": "count", "value": "", "type": "query", "description": "Maximum number of results to return" } ] }, "docs": "Returns a paginated list of user-defined tags for a Pulumi ESC environment. Tags are key-value pairs used for organizing and categorizing environments. Use the after parameter for cursor-based pagination and count to limit the number of results returned." }, { "info": { "name": "CreateEnvironmentTag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetEnvironmentTag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "tagName", "value": "", "type": "path", "description": "The environment tag name" } ] }, "docs": "Returns a single user-defined tag for a Pulumi ESC environment, identified by the tag name in the URL path. The response includes the tag name, value, and metadata. Returns 404 if the tag does not exist on the environment." }, { "info": { "name": "UpdateEnvironmentTag", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "tagName", "value": "", "type": "path", "description": "The environment tag name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the value of an existing user-defined tag on a Pulumi ESC environment. The tag is identified by its name in the URL path. The request body contains the new value for the tag. Returns the updated EnvironmentTag on success. Returns 404 if the tag does not exist on the environment." }, { "info": { "name": "DeleteEnvironmentTag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "tagName", "value": "", "type": "path", "description": "The environment tag name" } ] }, "docs": "Removes a user-defined tag from a Pulumi ESC environment. The tag is identified by its name in the URL path. Returns 204 on success with no response body. Returns 404 if the tag does not exist on the environment." }, { "info": { "name": "ListEnvironmentRevisions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/versions", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "before", "value": "", "type": "query", "description": "Only return results before this revision" }, { "name": "count", "value": "", "type": "query", "description": "Maximum number of results to return" } ] }, "docs": "Returns a paginated list of revisions for a Pulumi ESC environment. Each revision represents an immutable snapshot of the environment definition created when the environment is updated. The response includes revision numbers, timestamps, and the identity of the user who made each change. Use the before parameter to fetch revisions before a specific revision number, and count to limit the number of results returned." }, { "info": { "name": "ListRevisionTags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/versions/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "after", "value": "", "type": "query", "description": "Only return results after this value" }, { "name": "count", "value": "", "type": "query", "description": "Maximum number of results to return" } ] }, "docs": "Returns a paginated list of revision tags for a Pulumi ESC environment. Revision tags are named references pointing to specific revision numbers (e.g., 'latest', 'prod', 'stable'). They can be used in environment imports and Pulumi stack configuration to pin to a specific version. Use the after parameter for cursor-based pagination and count to limit results." }, { "info": { "name": "CreateRevisionTag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/versions/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "ReadRevisionTag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/versions/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "tagName", "value": "", "type": "path", "description": "The revision tag name" } ] }, "docs": "Returns the details of a specific revision tag for a Pulumi ESC environment. The tag is identified by its name in the URL path. The response includes the tag name and the revision number it points to. Returns 404 if the tag does not exist." }, { "info": { "name": "UpdateRevisionTag", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/versions/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "tagName", "value": "", "type": "path", "description": "The revision tag name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing revision tag for a Pulumi ESC environment to point to a different revision number. The tag is identified by its name in the URL path. The request body specifies the new revision number. This allows advancing or rolling back a named reference (e.g., moving the 'prod' tag to a newer or older revision). Returns 204 on success with no response body." }, { "info": { "name": "DeleteRevisionTag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/versions/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "tagName", "value": "", "type": "path", "description": "The revision tag name" } ] }, "docs": "Deletes a named revision tag from a Pulumi ESC environment. The tag is identified by its name in the URL path. After deletion, any imports or stack configurations referencing this tag will fail to resolve. The built-in 'latest' tag cannot be deleted. Returns 204 on success with no response body." }, { "info": { "name": "ReadEnvironment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/versions/:version", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "version", "value": "", "type": "path", "description": "The revision version number" } ] }, "docs": "Returns the YAML definition of a Pulumi ESC environment. The response is in application/x-yaml format and includes the environment's imports, values, provider configurations, and function invocations. Secrets remain in their encrypted form (use DecryptEnvironment to see plaintext secrets, or OpenEnvironment to fully resolve all dynamic values). When a version path parameter is provided, returns the definition for that specific revision." }, { "info": { "name": "CheckEnvironment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/versions/:version/check", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "version", "value": "", "type": "path", "description": "The revision version number" }, { "name": "showSecrets", "value": "", "type": "query", "description": "Whether to show secret values in plaintext" } ] }, "docs": "Checks a Pulumi ESC environment definition for errors without applying changes. This validates the YAML definition including imports, provider configurations, function invocations (fn::open, fn::secret, etc.), and interpolation expressions. When the showSecrets query parameter is set to true, secret values are returned in plaintext in the response. The response includes any diagnostics or validation errors found in the environment definition. Supports optimistic concurrency control via ETag head" }, { "info": { "name": "DecryptEnvironment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/versions/:version/decrypt", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "version", "value": "", "type": "path", "description": "The revision version number" } ] }, "docs": "Reads the YAML definition for a Pulumi ESC environment with all static secrets decrypted and shown in plaintext. Unlike the standard ReadEnvironment endpoint which returns secrets in their encrypted form, this endpoint resolves fn::secret values to their plaintext representations. The response is returned in application/x-yaml format. This does not resolve dynamic provider values (fn::open); use OpenEnvironment for full resolution. Requires environment open permission." }, { "info": { "name": "OpenEnvironment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/versions/:version/open", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "version", "value": "", "type": "path", "description": "The revision version number" }, { "name": "duration", "value": "", "type": "query", "description": "The session duration, using Go time units: ns, us, ms, s, m, h (e.g. '2h')" } ] }, "docs": "Opens a Pulumi ESC environment, fully resolving all dynamic values, provider integrations (fn::open), interpolation expressions, and secrets. This initiates an access session that evaluates the complete environment definition including all imports. The duration parameter specifies how long the session remains valid using Go duration format (e.g., '2h45m', '300ms'). Returns an OpenEnvironmentResponse containing the session ID and any diagnostics. Use the session ID with ReadOpenEnvironment to ret" }, { "info": { "name": "ListEnvironmentReferrers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/versions/:version/referrers", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "version", "value": "", "type": "path", "description": "The revision version number" }, { "name": "allRevisions", "value": "", "type": "query", "description": "Whether to include all revisions" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "count", "value": "", "type": "query", "description": "Maximum number of results to return" }, { "name": "latestStackVersionOnly", "value": "", "type": "query", "description": "Whether to return only the latest stack version" } ] }, "docs": "Returns a paginated list of entities that reference a Pulumi ESC environment, including other environments that import it and Pulumi stacks that use it in their configuration. The count parameter limits results (range 1-500). Set allRevisions to true to include references across all revisions, and latestStackVersionOnly to true to return only the latest stack version for each referring stack. Use continuationToken for pagination." }, { "info": { "name": "RetractEnvironmentRevision", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/versions/:version/retract", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "version", "value": "", "type": "path", "description": "The revision version number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retracts a specific revision of a Pulumi ESC environment, marking it as withdrawn. A retracted revision remains in the history but is no longer considered a valid version for use. The request body may include a reason for the retraction. The revision is identified by the version path parameter. Returns 204 on success with no response body." }, { "info": { "name": "ListRevisionTags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/environments/:orgName/:projectName/:envName/versions/:version/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "version", "value": "", "type": "path", "description": "The revision version number" }, { "name": "after", "value": "", "type": "query", "description": "Only return results after this value" }, { "name": "count", "value": "", "type": "query", "description": "Maximum number of results to return" } ] }, "docs": "Returns a paginated list of revision tags for a Pulumi ESC environment. Revision tags are named references pointing to specific revision numbers (e.g., 'latest', 'prod', 'stable'). They can be used in environment imports and Pulumi stack configuration to pin to a specific version. Use the after parameter for cursor-based pagination and count to limit results." }, { "info": { "name": "ListProviders", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/providers", "params": [ { "name": "orgName", "value": "", "type": "query", "description": "Filter providers available to this organization" } ] }, "docs": "Returns a list of all available Pulumi ESC providers. Providers are integrations that dynamically retrieve configuration and secrets from external sources (e.g., AWS, Azure, Google Cloud, HashiCorp Vault, 1Password) via the fn::open function in environment definitions. Optionally filter by organization using the orgName query parameter to see only providers available to that organization." }, { "info": { "name": "GetProviderSchema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/providers/:providerName/schema", "params": [ { "name": "providerName", "value": "", "type": "path", "description": "The provider name" } ] }, "docs": "Returns the JSON schema for a Pulumi ESC provider. Providers are integrations that dynamically retrieve configuration and secrets from external sources such as AWS, Azure, Google Cloud, HashiCorp Vault, and others via fn::open. The schema describes the provider's input parameters, output structure, and configuration options. The provider is identified by name in the URL path." }, { "info": { "name": "ListRotators", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/rotators", "params": [ { "name": "orgName", "value": "", "type": "query", "description": "Filter rotators available to this organization" } ] }, "docs": "Returns a list of all available Pulumi ESC secret rotators. Rotators are integrations that automatically rotate secrets in external systems via the fn::rotate function in environment definitions. Optionally filter by organization using the orgName query parameter to see only rotators available to that organization." }, { "info": { "name": "GetRotatorSchema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/esc/rotators/:rotatorName/schema", "params": [ { "name": "rotatorName", "value": "", "type": "path", "description": "The rotator name" } ] }, "docs": "Returns the JSON schema for a Pulumi ESC secret rotator. Rotators are integrations that automatically rotate secrets in external systems via fn::rotate. The schema describes the rotator's input parameters, output structure, and configuration options. The rotator is identified by name in the URL path." }, { "info": { "name": "ListEnvironments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments", "params": [ { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "includeReferrerMetadata", "value": "", "type": "query", "description": "Whether to include referrer metadata. Defaults to false." }, { "name": "maxResults", "value": "", "type": "query", "description": "Maximum number of results for pagination" }, { "name": "organization", "value": "", "type": "query", "description": "Filter results to this organization name" } ] }, "docs": "Returns a paginated list of all Pulumi ESC environments accessible to the authenticated user across all organizations they belong to. Each entry includes the organization, project, environment name, and creation/modification timestamps. Use the organization query parameter to filter results to a specific organization. Use continuationToken for pagination through large result sets." }, { "info": { "name": "ListProviders", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/providers", "params": [ { "name": "orgName", "value": "", "type": "query", "description": "Filter providers available to this organization" } ] }, "docs": "Returns a list of all available Pulumi ESC providers. Providers are integrations that dynamically retrieve configuration and secrets from external sources (e.g., AWS, Azure, Google Cloud, HashiCorp Vault, 1Password) via the fn::open function in environment definitions. Optionally filter by organization using the orgName query parameter to see only providers available to that organization." }, { "info": { "name": "GetProviderSchema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/providers/:providerName/schema", "params": [ { "name": "providerName", "value": "", "type": "path", "description": "The provider name" } ] }, "docs": "Returns the JSON schema for a Pulumi ESC provider. Providers are integrations that dynamically retrieve configuration and secrets from external sources such as AWS, Azure, Google Cloud, HashiCorp Vault, and others via fn::open. The schema describes the provider's input parameters, output structure, and configuration options. The provider is identified by name in the URL path." }, { "info": { "name": "ListOrgEnvironments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "includeReferrerMetadata", "value": "", "type": "query", "description": "Whether to include referrer metadata. Defaults to false." }, { "name": "maxResults", "value": "", "type": "query", "description": "Maximum number of results for pagination" }, { "name": "roleID", "value": "", "type": "query", "description": "The custom role to use for listing environments" } ] }, "docs": "Returns a paginated list of all Pulumi ESC environments within a specific organization. Each entry includes the project, environment name, and creation/modification timestamps. Results are scoped to the organization specified in the URL path. Use continuationToken for pagination through large result sets." }, { "info": { "name": "ListAllEnvironmentTags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns a map of all unique tag names and their distinct values across all Pulumi ESC environments in the organization. The response is a map where each key is a tag name and the value is a list of all distinct values for that tag across all environments. This is useful for building tag-based filtering or discovery UIs." }, { "info": { "name": "CheckYAML", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/environments/:orgName/yaml/check", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "showSecrets", "value": "", "type": "query", "description": "Whether to show secret values in plaintext" } ] }, "docs": "Checks a raw YAML environment definition for errors without creating or modifying any environment. The YAML definition is provided in the request body and validated for correctness, including imports, provider configurations, function invocations, and interpolation expressions. When the showSecrets query parameter is set to true, secret values are returned in plaintext in the response. This is useful for validating environment definitions before applying them." }, { "info": { "name": "OpenYAML", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/environments/:orgName/yaml/open", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "duration", "value": "", "type": "query", "description": "The session duration, using Go time units: ns, us, ms, s, m, h (e.g. '2h')" } ] }, "docs": "Opens an anonymous Pulumi ESC environment from a raw YAML definition provided in the request body, fully resolving all dynamic values, provider integrations, and secrets. Unlike OpenEnvironment, this does not require a pre-existing environment to be stored. The duration parameter specifies how long the session remains valid using Go duration format. Returns an OpenEnvironmentResponse containing the session ID. Use the session ID with ReadAnonymousOpenEnvironment to retrieve the resolved values." }, { "info": { "name": "ReadAnonymousOpenEnvironment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/yaml/open/:openSessionID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "openSessionID", "value": "", "type": "path", "description": "The session ID returned from the open environment operation" }, { "name": "property", "value": "", "type": "query", "description": "A dot-separated path to a specific property to retrieve from the environment" } ] }, "docs": "Reads the fully resolved values from an anonymous open environment session that was created via the OpenYAML endpoint. The openSessionID path parameter must match a valid, non-expired session. The optional property query parameter accepts a dot-separated path to retrieve a specific nested value instead of the entire resolved environment (e.g., 'aws.credentials.accessKeyId'). The response contains the resolved configuration values with secrets decrypted." }, { "info": { "name": "ReadEnvironment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Returns the YAML definition of a Pulumi ESC environment. The response is in application/x-yaml format and includes the environment's imports, values, provider configurations, and function invocations. Secrets remain in their encrypted form (use DecryptEnvironment to see plaintext secrets, or OpenEnvironment to fully resolve all dynamic values). When a version path parameter is provided, returns the definition for that specific revision." }, { "info": { "name": "CreateEnvironment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "UpdateEnvironment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Validates and updates the YAML definition of a Pulumi ESC environment. The request body must contain the complete environment definition in application/x-yaml format, including imports, values, provider configurations, and function invocations. Each successful update creates a new immutable revision in the environment's version history. Supports optimistic concurrency control via ETag/If-Match headers; returns 409 if the environment has been modified since it was last read." }, { "info": { "name": "DeleteEnvironment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Permanently deletes a Pulumi ESC environment and all of its revision history, tags, and associated configuration. This operation is blocked if deletion protection is enabled on the environment (see PatchEnvironmentSettings). Enterprise and Business Critical edition organizations may be able to restore deleted environments within a retention window. Returns 409 if the environment is deletion-protected or has been modified since it was last read." }, { "info": { "name": "HeadEnvironment", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Returns the ETag header for a Pulumi ESC environment without returning the full definition body. This is used for lightweight existence checks and for obtaining the current ETag value for optimistic concurrency control. The ETag should be included in subsequent update requests via the If-Match header to prevent concurrent modification conflicts. Returns 404 if the environment does not exist." }, { "info": { "name": "CheckEnvironment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/check", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "showSecrets", "value": "", "type": "query", "description": "Whether to show secret values in plaintext" } ] }, "docs": "Checks a Pulumi ESC environment definition for errors without applying changes. This validates the YAML definition including imports, provider configurations, function invocations (fn::open, fn::secret, etc.), and interpolation expressions. When the showSecrets query parameter is set to true, secret values are returned in plaintext in the response. The response includes any diagnostics or validation errors found in the environment definition. Supports optimistic concurrency control via ETag head" }, { "info": { "name": "DecryptEnvironment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/decrypt", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Reads the YAML definition for a Pulumi ESC environment with all static secrets decrypted and shown in plaintext. Unlike the standard ReadEnvironment endpoint which returns secrets in their encrypted form, this endpoint resolves fn::secret values to their plaintext representations. The response is returned in application/x-yaml format. This does not resolve dynamic provider values (fn::open); use OpenEnvironment for full resolution. Requires environment open permission." }, { "info": { "name": "ListWebhooks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/hooks", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Returns a list of all webhooks configured for a Pulumi ESC environment. Each webhook entry includes its name, destination URL, event filters, format, and active status. Webhooks enable external services to be notified of environment events such as updates and opens." }, { "info": { "name": "CreateWebhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/hooks", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetWebhook", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/hooks/:hookName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ] }, "docs": "Returns the configuration and status of a single webhook for a Pulumi ESC environment. The webhook is identified by its name in the URL path. The response includes the webhook's destination URL, event filters, format, and active status. Returns 404 if the webhook does not exist." }, { "info": { "name": "UpdateWebhook", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/hooks/:hookName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of an existing webhook on a Pulumi ESC environment. The webhook is identified by its name in the URL path. The request body contains the updated webhook configuration including destination URL, event filters, format, and active status. Returns the updated WebhookResponse on success. Returns 400 if an invalid format is specified." }, { "info": { "name": "DeleteWebhook", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/hooks/:hookName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ] }, "docs": "Deletes a webhook from a Pulumi ESC environment. The webhook is identified by its name in the URL path. After deletion, the external service will no longer receive notifications for environment events. Returns 204 on success with no response body." }, { "info": { "name": "GetWebhookDeliveries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/hooks/:hookName/deliveries", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ] }, "docs": "Returns a list of recent delivery attempts for a specific webhook on a Pulumi ESC environment. Each delivery record includes the HTTP status code, response body, timestamp, and whether the delivery was successful. This is useful for debugging webhook integration issues and verifying that events are being received." }, { "info": { "name": "RedeliverWebhookEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/hooks/:hookName/deliveries/:event/redeliver", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" }, { "name": "event", "value": "", "type": "path", "description": "The webhook delivery event ID to redeliver" } ] }, "docs": "Triggers the Pulumi Service to redeliver a specific event to a webhook on a Pulumi ESC environment. This is useful for resending events that the webhook endpoint failed to process on the initial delivery attempt (e.g., due to temporary downtime or errors). The event is identified by its delivery event ID in the URL path. Returns the new WebhookDelivery record for the redelivery." }, { "info": { "name": "PingWebhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/hooks/:hookName/ping", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "hookName", "value": "", "type": "path", "description": "The webhook name" } ] }, "docs": "Sends a test ping event to a webhook on a Pulumi ESC environment to verify that the webhook endpoint is reachable and functioning correctly. This bypasses the normal message queue and issues the request directly to the webhook URL. Returns the WebhookDelivery record containing the HTTP status code and response from the target endpoint." }, { "info": { "name": "GetEnvironmentMetadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/metadata", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "Returns metadata for a Pulumi ESC environment, including the calling user's effective permission level (read, open, write, admin), creation and modification timestamps, the environment's project, and other administrative information. This is useful for determining what actions the current user can perform on the environment before attempting those operations." }, { "info": { "name": "OpenEnvironment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/open", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "duration", "value": "", "type": "query", "description": "The session duration, using Go time units: ns, us, ms, s, m, h (e.g. '2h')" } ] }, "docs": "Opens a Pulumi ESC environment, fully resolving all dynamic values, provider integrations (fn::open), interpolation expressions, and secrets. This initiates an access session that evaluates the complete environment definition including all imports. The duration parameter specifies how long the session remains valid using Go duration format (e.g., '2h45m', '300ms'). Returns an OpenEnvironmentResponse containing the session ID and any diagnostics. Use the session ID with ReadOpenEnvironment to ret" }, { "info": { "name": "ReadOpenEnvironment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/open/:openSessionID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "openSessionID", "value": "", "type": "path", "description": "The session ID returned from the open environment operation" }, { "name": "property", "value": "", "type": "query", "description": "A dot-separated path to a specific property to retrieve from the environment" } ] }, "docs": "Reads the fully resolved values from an open environment session that was created via the OpenEnvironment endpoint. The openSessionID path parameter must match a valid, non-expired session. The optional property query parameter accepts a dot-separated path to retrieve a specific nested value instead of the entire resolved environment (e.g., 'aws.credentials.accessKeyId'). The response contains all resolved configuration values with secrets decrypted and provider-sourced values fully evaluated." }, { "info": { "name": "ListEnvironmentTags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "after", "value": "", "type": "query", "description": "Only return results after this value" }, { "name": "count", "value": "", "type": "query", "description": "Maximum number of results to return" } ] }, "docs": "Returns a paginated list of user-defined tags for a Pulumi ESC environment. Tags are key-value pairs used for organizing and categorizing environments. Use the after parameter for cursor-based pagination and count to limit the number of results returned." }, { "info": { "name": "CreateEnvironmentTag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetEnvironmentTag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "tagName", "value": "", "type": "path", "description": "The environment tag name" } ] }, "docs": "Returns a single user-defined tag for a Pulumi ESC environment, identified by the tag name in the URL path. The response includes the tag name, value, and metadata. Returns 404 if the tag does not exist on the environment." }, { "info": { "name": "UpdateEnvironmentTag", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "tagName", "value": "", "type": "path", "description": "The environment tag name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the value of an existing user-defined tag on a Pulumi ESC environment. The tag is identified by its name in the URL path. The request body contains the new value for the tag. Returns the updated EnvironmentTag on success. Returns 404 if the tag does not exist on the environment." }, { "info": { "name": "DeleteEnvironmentTag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "tagName", "value": "", "type": "path", "description": "The environment tag name" } ] }, "docs": "Removes a user-defined tag from a Pulumi ESC environment. The tag is identified by its name in the URL path. Returns 204 on success with no response body. Returns 404 if the tag does not exist on the environment." }, { "info": { "name": "ListEnvironmentRevisions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/versions", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "before", "value": "", "type": "query", "description": "Only return results before this revision" }, { "name": "count", "value": "", "type": "query", "description": "Maximum number of results to return" } ] }, "docs": "Returns a paginated list of revisions for a Pulumi ESC environment. Each revision represents an immutable snapshot of the environment definition created when the environment is updated. The response includes revision numbers, timestamps, and the identity of the user who made each change. Use the before parameter to fetch revisions before a specific revision number, and count to limit the number of results returned." }, { "info": { "name": "ListRevisionTags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/versions/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "after", "value": "", "type": "query", "description": "Only return results after this value" }, { "name": "count", "value": "", "type": "query", "description": "Maximum number of results to return" } ] }, "docs": "Returns a paginated list of revision tags for a Pulumi ESC environment. Revision tags are named references pointing to specific revision numbers (e.g., 'latest', 'prod', 'stable'). They can be used in environment imports and Pulumi stack configuration to pin to a specific version. Use the after parameter for cursor-based pagination and count to limit results." }, { "info": { "name": "ReadRevisionTag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/versions/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "tagName", "value": "", "type": "path", "description": "The revision tag name" } ] }, "docs": "Returns the details of a specific revision tag for a Pulumi ESC environment. The tag is identified by its name in the URL path. The response includes the tag name and the revision number it points to. Returns 404 if the tag does not exist." }, { "info": { "name": "CreateRevisionTag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/versions/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "tagName", "value": "", "type": "path", "description": "The revision tag name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "UpdateRevisionTag", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/versions/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "tagName", "value": "", "type": "path", "description": "The revision tag name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing revision tag for a Pulumi ESC environment to point to a different revision number. The tag is identified by its name in the URL path. The request body specifies the new revision number. This allows advancing or rolling back a named reference (e.g., moving the 'prod' tag to a newer or older revision). Returns 204 on success with no response body." }, { "info": { "name": "DeleteRevisionTag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/versions/tags/:tagName", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "tagName", "value": "", "type": "path", "description": "The revision tag name" } ] }, "docs": "Deletes a named revision tag from a Pulumi ESC environment. The tag is identified by its name in the URL path. After deletion, any imports or stack configurations referencing this tag will fail to resolve. The built-in 'latest' tag cannot be deleted. Returns 204 on success with no response body." }, { "info": { "name": "ReadEnvironment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/versions/:version", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "version", "value": "", "type": "path", "description": "The revision version number" } ] }, "docs": "Returns the YAML definition of a Pulumi ESC environment. The response is in application/x-yaml format and includes the environment's imports, values, provider configurations, and function invocations. Secrets remain in their encrypted form (use DecryptEnvironment to see plaintext secrets, or OpenEnvironment to fully resolve all dynamic values). When a version path parameter is provided, returns the definition for that specific revision." }, { "info": { "name": "CheckEnvironment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/versions/:version/check", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "version", "value": "", "type": "path", "description": "The revision version number" }, { "name": "showSecrets", "value": "", "type": "query", "description": "Whether to show secret values in plaintext" } ] }, "docs": "Checks a Pulumi ESC environment definition for errors without applying changes. This validates the YAML definition including imports, provider configurations, function invocations (fn::open, fn::secret, etc.), and interpolation expressions. When the showSecrets query parameter is set to true, secret values are returned in plaintext in the response. The response includes any diagnostics or validation errors found in the environment definition. Supports optimistic concurrency control via ETag head" }, { "info": { "name": "DecryptEnvironment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/versions/:version/decrypt", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "version", "value": "", "type": "path", "description": "The revision version number" } ] }, "docs": "Reads the YAML definition for a Pulumi ESC environment with all static secrets decrypted and shown in plaintext. Unlike the standard ReadEnvironment endpoint which returns secrets in their encrypted form, this endpoint resolves fn::secret values to their plaintext representations. The response is returned in application/x-yaml format. This does not resolve dynamic provider values (fn::open); use OpenEnvironment for full resolution. Requires environment open permission." }, { "info": { "name": "OpenEnvironment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/versions/:version/open", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "version", "value": "", "type": "path", "description": "The revision version number" }, { "name": "duration", "value": "", "type": "query", "description": "The session duration, using Go time units: ns, us, ms, s, m, h (e.g. '2h')" } ] }, "docs": "Opens a Pulumi ESC environment, fully resolving all dynamic values, provider integrations (fn::open), interpolation expressions, and secrets. This initiates an access session that evaluates the complete environment definition including all imports. The duration parameter specifies how long the session remains valid using Go duration format (e.g., '2h45m', '300ms'). Returns an OpenEnvironmentResponse containing the session ID and any diagnostics. Use the session ID with ReadOpenEnvironment to ret" }, { "info": { "name": "ListEnvironmentReferrers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/versions/:version/referrers", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "version", "value": "", "type": "path", "description": "The revision version number" }, { "name": "allRevisions", "value": "", "type": "query", "description": "Whether to include all revisions" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Continuation token for paginated results" }, { "name": "count", "value": "", "type": "query", "description": "Maximum number of results to return" }, { "name": "latestStackVersionOnly", "value": "", "type": "query", "description": "Whether to return only the latest stack version" } ] }, "docs": "Returns a paginated list of entities that reference a Pulumi ESC environment, including other environments that import it and Pulumi stacks that use it in their configuration. The count parameter limits results (range 1-500). Set allRevisions to true to include references across all revisions, and latestStackVersionOnly to true to return only the latest stack version for each referring stack. Use continuationToken for pagination." }, { "info": { "name": "RetractEnvironmentRevision", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/versions/:version/retract", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "version", "value": "", "type": "path", "description": "The revision version number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retracts a specific revision of a Pulumi ESC environment, marking it as withdrawn. A retracted revision remains in the history but is no longer considered a valid version for use. The request body may include a reason for the retraction. The revision is identified by the version path parameter. Returns 204 on success with no response body." }, { "info": { "name": "ListRevisionTags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/environments/:orgName/:envName/versions/:version/tags", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "version", "value": "", "type": "path", "description": "The revision version number" }, { "name": "after", "value": "", "type": "query", "description": "Only return results after this value" }, { "name": "count", "value": "", "type": "query", "description": "Maximum number of results to return" } ] }, "docs": "Returns a paginated list of revision tags for a Pulumi ESC environment. Revision tags are named references pointing to specific revision numbers (e.g., 'latest', 'prod', 'stable'). They can be used in environment imports and Pulumi stack configuration to pin to a specific version. Use the after parameter for cursor-based pagination and count to limit results." }, { "info": { "name": "CreateEnvironmentDraft", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/esc/environments/:orgName/:projectName/:envName/drafts", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" } ] }, "docs": "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." }, { "info": { "name": "ReadEnvironmentDraft", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/esc/environments/:orgName/:projectName/:envName/drafts/:changeRequestID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request ID" }, { "name": "revision", "value": "", "type": "query", "description": "The environment revision number to target" } ] }, "docs": "Reads the YAML definition for a draft version of a Pulumi ESC environment. Drafts are proposed changes created as part of the approvals workflow. The draft is identified by the changeRequestID path parameter. An optional revision query parameter can target a specific base revision. The response is returned in application/x-yaml format. Requires the Approvals feature to be enabled." }, { "info": { "name": "UpdateEnvironmentDraft", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/preview/esc/environments/:orgName/:projectName/:envName/drafts/:changeRequestID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request ID" } ] }, "docs": "Updates the YAML definition of an existing draft change request for a Pulumi ESC environment. The draft is identified by the changeRequestID path parameter. The request body contains the updated YAML definition. Returns a ChangeRequestRef on success. Requires the Approvals feature to be enabled for the organization." }, { "info": { "name": "OpenEnvironmentDraft", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/esc/environments/:orgName/:projectName/:envName/drafts/:changeRequestID/open", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "projectName", "value": "", "type": "path", "description": "The project name" }, { "name": "envName", "value": "", "type": "path", "description": "The environment name" }, { "name": "changeRequestID", "value": "", "type": "path", "description": "The change request ID" }, { "name": "duration", "value": "", "type": "query", "description": "The session duration, using Go time units: ns, us, ms, s, m, h (e.g. '2h')" }, { "name": "revision", "value": "", "type": "query", "description": "The environment revision number to target" } ] }, "docs": "Opens a draft version of a Pulumi ESC environment, fully resolving all dynamic values, provider integrations, and secrets for the proposed changes. The duration parameter specifies how long the open session remains valid using Go duration format (e.g., '2h', '30m'). An optional revision parameter can target a specific base revision. Returns an OpenEnvironmentResponse containing the session ID for subsequent reads. Requires the Approvals feature." } ] }, { "info": { "name": "Workflows", "type": "folder" }, "items": [ { "info": { "name": "ListOrgAgentPool", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/agent-pools", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "Returns all agent pools configured for an organization. Agent pools enable self-hosted deployment agents, allowing organizations to run Pulumi Deployments on their own infrastructure for accessing private networks, meeting compliance requirements, or using custom execution environments. Each pool in the response includes its ID, name, and configuration details." }, { "info": { "name": "CreateOrgAgentPool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/orgs/:orgName/agent-pools", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 " }, { "info": { "name": "GetAgentPool", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/orgs/:orgName/agent-pools/:poolId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "poolId", "value": "", "type": "path", "description": "The agent pool identifier" } ] }, "docs": "Returns the details of a specific agent pool, including its name, ID, creation timestamp, and configuration. Agent pools enable self-hosted deployment agents that run Pulumi Deployments on organization-managed infrastructure. The pool ID can be referenced in stack deployment settings to route deployments to self-hosted agents instead of Pulumi-managed infrastructure." }, { "info": { "name": "PatchOrgAgentPool", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/orgs/:orgName/agent-pools/:poolId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "poolId", "value": "", "type": "path", "description": "The agent pool identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing agent pool's configuration for an organization. This can be used to modify the pool's name or other configurable properties. The request body uses the same format as CreateOrgAgentPool. Only provided fields are updated; omitted fields remain unchanged." }, { "info": { "name": "DeleteOrgAgentPool", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/orgs/:orgName/agent-pools/:poolId", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "poolId", "value": "", "type": "path", "description": "The agent pool identifier" }, { "name": "force", "value": "", "type": "query", "description": "Force the operation even if the pool is in use" } ] }, "docs": "Deletes an agent pool from an organization. If the agent pool is currently referenced by any stack's deployment settings, the deletion will fail with a 400 error unless the 'force' query parameter is set to true. Force-deleting a pool that is in use will cause affected stacks to fall back to Pulumi-managed infrastructure for future deployments. Returns 204 No Content on success." } ] }, { "info": { "name": "AI Agents", "type": "folder" }, "items": [ { "info": { "name": "ListTasks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/agents/:orgName/tasks", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Token for retrieving the next page of results" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "sortBy", "value": "", "type": "query", "description": "Field to sort the results by. Defaults to lastEvent." }, { "name": "sortDirection", "value": "", "type": "query", "description": "Direction to sort the results in. Defaults to desc." }, { "name": "taskType", "value": "", "type": "query", "description": "Task type to filter by" } ] }, "docs": "Lists all agent tasks for the specified organization. Supports pagination via continuationToken with a configurable pageSize (1-1000, default 100). Returns task metadata including ID, name, status, and creation timestamp." }, { "info": { "name": "CreateTasks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/agents/:orgName/tasks", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GetTask", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/agents/:orgName/tasks/:taskID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "taskID", "value": "", "type": "path", "description": "The agent task identifier" } ] }, "docs": "Retrieves metadata for a specific agent task, including its ID, name, status, creation timestamp, and associated entities. Returns 404 if the task does not exist." }, { "info": { "name": "RespondToTask", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/agents/:orgName/tasks/:taskID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "taskID", "value": "", "type": "path", "description": "The agent task identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sends a response to an ongoing agent task. Supported event types include user_message, user_confirmation, and user_cancel. Returns 409 if the task already has a pending request that has not completed." }, { "info": { "name": "UpdateTask", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/preview/agents/:orgName/tasks/:taskID", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "taskID", "value": "", "type": "path", "description": "The agent task identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the settings or metadata of an agent task. Only the user who created the task can modify it." }, { "info": { "name": "CancelTask", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/agents/:orgName/tasks/:taskID/cancel", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "taskID", "value": "", "type": "path", "description": "The agent task identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancels an agent task. When force is true, immediately terminates the runtime session and resets the task to idle. This is the escalation path when a graceful cancel (via the user_cancel event in RespondToTask) is insufficient or the task is stuck. Unlike graceful cancel, force-cancel does not attempt to notify the agent runtime — it kills the session directly and resets the task state. Currently only force cancellation is supported; the force field must be set to true. Returns 409 if the sessio" }, { "info": { "name": "GetTaskEvents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/agents/:orgName/tasks/:taskID/events", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "taskID", "value": "", "type": "path", "description": "The agent task identifier" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Token for retrieving the next page of results" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results per page" } ] }, "docs": "Retrieves the event stream for a specific agent task. Events include agent messages, tool calls, status changes, and user interactions. Supports pagination via continuationToken with a configurable pageSize (1-1000)." }, { "info": { "name": "StreamTaskEvents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/agents/:orgName/tasks/:taskID/events/stream", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" }, { "name": "taskID", "value": "", "type": "path", "description": "The agent task identifier" } ] }, "docs": "Streams events for a specific agent task as Server-Sent Events. Each SSE data frame contains a JSON-encoded AgentConsoleEvent. The stream delivers existing events immediately, then keeps the connection open to deliver new events in real time until the task completes." } ] }, { "info": { "name": "RegistryPreview", "type": "folder" }, "items": [ { "info": { "name": "ListPackages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/registry/packages", "params": [ { "name": "asc", "value": "", "type": "query", "description": "When true, sort results in ascending order" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Pagination token for retrieving the next page of results" }, { "name": "limit", "value": "", "type": "query", "description": "Results per page (default: 100)" }, { "name": "name", "value": "", "type": "query", "description": "Filter by specific package name" }, { "name": "orgLogin", "value": "", "type": "query", "description": "Filter by owning organization" }, { "name": "publisher", "value": "", "type": "query", "description": "Filter by publisher organization" }, { "name": "sort", "value": "", "type": "query", "description": "Sort field for results" }, { "name": "visibility", "value": "", "type": "query", "description": "Filter by visibility level" } ] }, "docs": "Retrieves all registry packages accessible to the caller, with support for filtering, sorting, and pagination. No authentication is required, but authenticated requests may include additional usage statistics per package. Results can be filtered by package name, publisher, owning organization, sort field, and visibility level. Results are paginated with a default limit of 100 per page; use the continuationToken from the response to retrieve subsequent pages. Each entry in the response contains t" }, { "info": { "name": "PostPublishPackageVersion", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/registry/packages/:source/:publisher/:name/versions", "params": [ { "name": "source", "value": "", "type": "path", "description": "The package source: 'pulumi', 'opentofu', or 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the package" }, { "name": "name", "value": "", "type": "path", "description": "The package name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the first step of a two-phase package version publish workflow. This creates a publish transaction and returns an operationID along with pre-signed upload URLs for the package artifacts (schema, index, and installationConfiguration). The caller must upload all required artifacts to the provided URLs and then call the PostPublishPackageVersionComplete endpoint with the operationID to finalize the publish. The request body must include the semantic version to publish. Returns 202 Accepte" }, { "info": { "name": "GetPackageVersion", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/registry/packages/:source/:publisher/:name/versions/:version", "params": [ { "name": "source", "value": "", "type": "path", "description": "The package source: 'pulumi', 'opentofu', or 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the package" }, { "name": "name", "value": "", "type": "path", "description": "The package name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string or 'latest'" } ] }, "docs": "Retrieves metadata for a specific version of a registry package. The package is identified by its source, publisher organization, and name. The version parameter accepts either a specific semantic version string or the special value 'latest' to retrieve the most recently published version. The response includes the package's name, publisher, version, title, description, repository URL, category, featured status, package types, maturity status, readme URL, schema URL, plugin download URL, creatio" }, { "info": { "name": "DeletePublishPackageVersion", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/preview/registry/packages/:source/:publisher/:name/versions/:version", "params": [ { "name": "source", "value": "", "type": "path", "description": "The package source: 'pulumi', 'opentofu', or 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the package" }, { "name": "name", "value": "", "type": "path", "description": "The package name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string of the package version to delete" } ] }, "docs": "Removes a specific version of a package from the registry. The package is identified by its source (e.g. 'pulumi', 'opentofu', or 'private'), publisher organization, name, and semantic version. Requires the RegistryPublish permission on the publisher organization. Returns 204 No Content on success." }, { "info": { "name": "PostPublishPackageVersionComplete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/registry/packages/:source/:publisher/:name/versions/:version/complete", "params": [ { "name": "source", "value": "", "type": "path", "description": "The package source: 'pulumi', 'opentofu', or 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the package" }, { "name": "name", "value": "", "type": "path", "description": "The package name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string of the package version to complete" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Finalizes the second step of the two-phase package version publish workflow. After initiating a publish with PostPublishPackageVersion and uploading all required artifacts (schema, index, installationConfiguration) to the pre-signed URLs, call this endpoint with the operationID to complete the publish. The service validates that all artifacts were uploaded successfully before making the version available in the registry. Returns 201 Created on success, 400 for a bad request (e.g. missing artifac" }, { "info": { "name": "ListPolicyPacks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/registry/policypacks", "params": [ { "name": "access", "value": "", "type": "query", "description": "Filter by access level" }, { "name": "orgLogin", "value": "", "type": "query", "description": "Required. Filter by owning organization" } ] }, "docs": "Lists all policy packs accessible to the calling user for a given organization. The orgLogin query parameter is required and restricts results to policy packs owned by that organization. Results can optionally be filtered by access level. No authentication is required. Returns 400 if the policy pack access filter value is invalid. This is the deprecated GET variant; prefer the POST ListPolicyPacks endpoint instead." }, { "info": { "name": "ListPolicyPacks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/registry/policypacks", "body": { "type": "json", "data": "{}" } }, "docs": "Lists all policy packs accessible to the calling user, with support for filtering by access level, organization, and specific policy pack IDs. The request body accepts an optional orgLogin to scope results to a specific organization, an optional access level filter (defaults to 'enabled'), and an optional list of policy pack IDs to restrict the results to specific packs. No authentication is required. Returns 400 if the access filter value is invalid." }, { "info": { "name": "DeletePolicyPack", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/preview/registry/policypacks/:source/:publisher/:name", "params": [ { "name": "source", "value": "", "type": "path", "description": "The policy pack source: 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the policy pack" }, { "name": "name", "value": "", "type": "path", "description": "The policy pack name" } ] }, "docs": "Deletes a policy pack and all of its versions from the registry. The policy pack is identified by its source (currently only 'private'), publisher organization, and name. This is a destructive operation that permanently removes the policy pack and all associated version data. Requires the RegistryPublish permission on the publisher organization. Returns 404 if the policy pack does not exist." }, { "info": { "name": "ListPolicyPackVersions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/registry/policypacks/:source/:publisher/:name/versions", "params": [ { "name": "source", "value": "", "type": "path", "description": "The policy pack source: 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the policy pack" }, { "name": "name", "value": "", "type": "path", "description": "The policy pack name" } ] }, "docs": "Lists all versions of a specific policy pack. The policy pack is identified by its source (currently only 'private'), publisher organization, and name. The response includes a list of policy pack version metadata and an optional continuationToken for pagination. Returns 404 if the policy pack does not exist." }, { "info": { "name": "PostPublishPolicyPackVersion", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/registry/policypacks/:source/:publisher/:name/versions", "params": [ { "name": "source", "value": "", "type": "path", "description": "The policy pack source: 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the policy pack" }, { "name": "name", "value": "", "type": "path", "description": "The policy pack name" } ] }, "docs": "Initiates the first step of a two-phase policy pack version publish workflow. The policy pack is identified by its source (currently only 'private'), publisher organization, and name. This creates a publish transaction that must be completed by calling PostPublishPolicyPackVersionComplete. Requires the RegistryPublish permission on the publisher organization. Returns 404 if the policy pack is not found." }, { "info": { "name": "GetPolicyPackVersion", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/registry/policypacks/:source/:publisher/:name/versions/:version", "params": [ { "name": "source", "value": "", "type": "path", "description": "The policy pack source: 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the policy pack" }, { "name": "name", "value": "", "type": "path", "description": "The policy pack name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string or 'latest'" } ] }, "docs": "Retrieves detailed information about a specific version of a policy pack, including the individual policy definitions. The policy pack is identified by its source (currently only 'private'), publisher organization, and name. The version parameter accepts either a specific semantic version string or the special value 'latest' to retrieve the most recently published version. The response includes the policy pack metadata and an optional list of policies, where each policy includes its configuratio" }, { "info": { "name": "DeletePolicyPack", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/preview/registry/policypacks/:source/:publisher/:name/versions/:version", "params": [ { "name": "source", "value": "", "type": "path", "description": "The policy pack source: 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the policy pack" }, { "name": "name", "value": "", "type": "path", "description": "The policy pack name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string of the policy pack version to delete" } ] }, "docs": "Deletes a specific version of a policy pack from the registry. The policy pack version is identified by its source (currently only 'private'), publisher organization, name, and semantic version string. Requires the RegistryPublish permission on the publisher organization. Returns 404 if the specified policy pack version does not exist." }, { "info": { "name": "PostPublishPolicyPackVersionComplete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/registry/policypacks/:source/:publisher/:name/versions/:version/complete", "params": [ { "name": "source", "value": "", "type": "path", "description": "The policy pack source: 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the policy pack" }, { "name": "name", "value": "", "type": "path", "description": "The policy pack name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string of the policy pack version to complete" } ] }, "docs": "Finalizes the second step of the two-phase policy pack version publish workflow. After initiating a publish with PostPublishPolicyPackVersion, call this endpoint with the policy pack source, publisher, name, and version to complete the publish and make the version available in the registry. Requires the RegistryPublish permission on the publisher organization. Returns 404 if the publish operation is not found." }, { "info": { "name": "ListTemplates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/registry/templates", "params": [ { "name": "continuationToken", "value": "", "type": "query", "description": "Pagination token for retrieving the next page of results" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return (default: 100)" }, { "name": "name", "value": "", "type": "query", "description": "Filter by specific template name" }, { "name": "orgLogin", "value": "", "type": "query", "description": "Filter by owning organization" }, { "name": "search", "value": "", "type": "query", "description": "Search query matching template name, display name, description, metadata values, or runtime language. Multiple space-separated terms require all terms to match (AND semantics)." } ] }, "docs": "Lists registry-backed templates with optional filtering, search, and pagination. This endpoint returns only registry-backed templates and does not include VCS-backed templates (those sourced from GitHub or GitLab repositories). No authentication is required. Results can be filtered by template name and owning organization (orgLogin). The search parameter performs case-insensitive partial matching against the template name, display name, description, metadata values, and runtime language. Results" }, { "info": { "name": "PostPublishTemplateVersion", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/registry/templates/:source/:publisher/:name/versions", "params": [ { "name": "source", "value": "", "type": "path", "description": "The template source: 'private', 'github', or 'gitlab'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the template" }, { "name": "name", "value": "", "type": "path", "description": "The template name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the first step of a two-phase template version publish workflow. This creates a publish transaction and returns an operationID along with a pre-signed upload URL for the template archive. The source must be 'private'. The caller must upload the template archive (a gzip-compressed tar file containing a root-level Pulumi.yaml with a template section, and optionally a README.md) to the provided URL, then call PostPublishTemplateVersionComplete with the operationID to finalize the publish." }, { "info": { "name": "GetTemplateVersion", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/preview/registry/templates/:source/:publisher/:name/versions/:version", "params": [ { "name": "source", "value": "", "type": "path", "description": "The template source: 'private', 'github', or 'gitlab'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the template" }, { "name": "name", "value": "", "type": "path", "description": "The template name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string or 'latest'" } ] }, "docs": "Retrieves metadata for a specific version of a registry template. The template is identified by its source (e.g. 'private', 'github', or 'gitlab'), publisher organization, and name. The version parameter accepts either a specific semantic version string or the special value 'latest' to retrieve the most recent version. The response includes the template's name, display name, description, runtime information, language, readme URL, download URL (a pre-signed URL valid for at least 5 minutes for re" }, { "info": { "name": "DeleteTemplateVersion", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/preview/registry/templates/:source/:publisher/:name/versions/:version", "params": [ { "name": "source", "value": "", "type": "path", "description": "The template source: 'private', 'github', or 'gitlab'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the template" }, { "name": "name", "value": "", "type": "path", "description": "The template name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string of the template version to delete" }, { "name": "force", "value": "", "type": "query", "description": "When true, allows deletion of the final remaining template version" } ] }, "docs": "Removes a specific version of a template from the registry. The template is identified by its source (e.g. 'private', 'github', or 'gitlab'), publisher organization, name, and semantic version. If this is the last remaining version of the template, the 'force' query parameter must be set to true; doing so will also delete the template itself. Returns 204 No Content on success, or 400 if an invalid query parameter is provided." }, { "info": { "name": "PostPublishTemplateVersionComplete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/preview/registry/templates/:source/:publisher/:name/versions/:version/complete", "params": [ { "name": "source", "value": "", "type": "path", "description": "The template source: 'private', 'github', or 'gitlab'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the template" }, { "name": "name", "value": "", "type": "path", "description": "The template name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string of the template version to complete" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Finalizes the second step of the two-phase template version publish workflow. After initiating a publish with PostPublishTemplateVersion and uploading the template archive (.tar.gz) to the pre-signed URL, call this endpoint with the operationID to complete the publish. The service validates that the archive was uploaded successfully before making the version available in the registry. Once complete, the template becomes available to the publisher's organization. Returns 201 Created on success, 4" } ] }, { "info": { "name": "Registry", "type": "folder" }, "items": [ { "info": { "name": "ListPackages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/registry/packages", "params": [ { "name": "asc", "value": "", "type": "query", "description": "When true, sort results in ascending order" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Pagination token for retrieving the next page of results" }, { "name": "limit", "value": "", "type": "query", "description": "Results per page (default: 100)" }, { "name": "name", "value": "", "type": "query", "description": "Filter by specific package name" }, { "name": "orgLogin", "value": "", "type": "query", "description": "Filter by owning organization" }, { "name": "packageType", "value": "", "type": "query", "description": "Filter by package type" }, { "name": "publisher", "value": "", "type": "query", "description": "Filter by publisher organization" }, { "name": "search", "value": "", "type": "query", "description": "Search query string" }, { "name": "sort", "value": "", "type": "query", "description": "Sort field for results" }, { "name": "usage", "value": "", "type": "query", "description": "Filter by usage type" }, { "name": "visibility", "value": "", "type": "query", "description": "Filter by visibility level" } ] }, "docs": "Retrieves all registry packages accessible to the caller, with support for filtering, sorting, and pagination. No authentication is required, but authenticated requests may include additional usage statistics per package. Results can be filtered by package name, publisher, owning organization, package type, usage, search query, and visibility level. The sort parameter controls the ordering of results, and the asc parameter toggles ascending vs. descending order. Results are paginated with a defa" }, { "info": { "name": "PostPublishPackageVersion", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/registry/packages/:source/:publisher/:name/versions", "params": [ { "name": "source", "value": "", "type": "path", "description": "The package source: 'pulumi', 'opentofu', or 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the package" }, { "name": "name", "value": "", "type": "path", "description": "The package name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the first step of a two-phase package version publish workflow. This creates a publish transaction and returns an operationID along with pre-signed upload URLs for the package artifacts (schema, index, and installationConfiguration). The caller must upload all required artifacts to the provided URLs and then call the PostPublishPackageVersionComplete endpoint with the operationID to finalize the publish. The request body must include the semantic version to publish. Returns 202 Accepte" }, { "info": { "name": "GetPackageVersion", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/registry/packages/:source/:publisher/:name/versions/:version", "params": [ { "name": "source", "value": "", "type": "path", "description": "The package source: 'pulumi', 'opentofu', or 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the package" }, { "name": "name", "value": "", "type": "path", "description": "The package name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string or 'latest'" } ] }, "docs": "Retrieves metadata for a specific version of a registry package. The package is identified by its source, publisher organization, and name. The version parameter accepts either a specific semantic version string or the special value 'latest' to retrieve the most recently published version. The response includes the package's name, publisher, version, title, description, repository URL, category, featured status, package types, maturity status, readme URL, schema URL, plugin download URL, creatio" }, { "info": { "name": "DeletePublishPackageVersion", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/registry/packages/:source/:publisher/:name/versions/:version", "params": [ { "name": "source", "value": "", "type": "path", "description": "The package source: 'pulumi', 'opentofu', or 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the package" }, { "name": "name", "value": "", "type": "path", "description": "The package name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string of the package version to delete" } ] }, "docs": "Removes a specific version of a package from the registry. The package is identified by its source (e.g. 'pulumi', 'opentofu', or 'private'), publisher organization, name, and semantic version. Requires the RegistryPublish permission on the publisher organization. Returns 204 No Content on success." }, { "info": { "name": "PostPublishPackageVersionComplete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/registry/packages/:source/:publisher/:name/versions/:version/complete", "params": [ { "name": "source", "value": "", "type": "path", "description": "The package source: 'pulumi', 'opentofu', or 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the package" }, { "name": "name", "value": "", "type": "path", "description": "The package name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string of the package version to complete" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Finalizes the second step of the two-phase package version publish workflow. After initiating a publish with PostPublishPackageVersion and uploading all required artifacts (schema, index, installationConfiguration) to the pre-signed URLs, call this endpoint with the operationID to complete the publish. The service validates that all artifacts were uploaded successfully before making the version available in the registry. Returns 201 Created on success, 400 for a bad request (e.g. missing artifac" }, { "info": { "name": "GetPackageDocs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/registry/packages/:source/:publisher/:name/versions/:version/docs/:token", "params": [ { "name": "source", "value": "", "type": "path", "description": "The package source: 'pulumi', 'opentofu', or 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the package" }, { "name": "name", "value": "", "type": "path", "description": "The package name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string or 'latest'" }, { "name": "token", "value": "", "type": "path", "description": "URL-encoded Pulumi token identifying the resource or function" }, { "name": "lang", "value": "", "type": "query", "description": "Language for filtering property names, types, descriptions, and code examples. Values: typescript, python, go, csharp, java, yaml" }, { "name": "os", "value": "", "type": "query", "description": "Filter OS choosers in descriptions to a single OS. Values: linux, macos, windows" } ] }, "docs": "Returns structured API documentation for a single resource or function identified by its Pulumi token. The token must be URL-encoded (e.g. 'random:index%2FrandomPassword:RandomPassword'). The 'lang' parameter is required and filters all property names, types, descriptions, and code examples to the specified language. Use the 'os' parameter to collapse OS choosers in descriptions. Supports content negotiation via the Accept header: send 'text/markdown' to receive a rendered markdown document with" }, { "info": { "name": "GetPackageInstallation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/registry/packages/:source/:publisher/:name/versions/:version/installation", "params": [ { "name": "source", "value": "", "type": "path", "description": "The package source: 'pulumi', 'opentofu', or 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the package" }, { "name": "name", "value": "", "type": "path", "description": "The package name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string or 'latest'" }, { "name": "lang", "value": "", "type": "query", "description": "Filter language-specific content to a single language. Values: typescript, python, go, csharp, java, yaml" }, { "name": "os", "value": "", "type": "query", "description": "Filter OS-specific content to a single OS. Values: linux, macos, windows" } ] }, "docs": "Returns installation configuration content for a registry package version, structured as an ordered list of content nodes. Not all packages include installation configuration; this endpoint returns 404 when absent. Use the 'lang' parameter to filter language-specific content to a single language (fallback chain: requested language, then Go, then first available). Use the 'os' parameter to filter OS-specific content similarly (fallback: Linux). Supports content negotiation via the Accept header: " }, { "info": { "name": "GetPackageNav", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/registry/packages/:source/:publisher/:name/versions/:version/nav", "params": [ { "name": "source", "value": "", "type": "path", "description": "The package source: 'pulumi', 'opentofu', or 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the package" }, { "name": "name", "value": "", "type": "path", "description": "The package name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string or 'latest'" }, { "name": "lang", "value": "", "type": "query", "description": "Language for name resolution. Names are resolved for this language with a fallback chain: requested language, then Go, then first available. Values: typescript, python, go, csharp, java, yaml" }, { "name": "q", "value": "", "type": "query", "description": "Search query for filtering the navigation tree. Case-insensitive matching against resource/function names and tokens" } ] }, "docs": "Returns the module, resource, and function navigation tree for a registry package version. Names are resolved for the requested language (defaulting to Go when omitted). Use the 'q' parameter for case-insensitive search: the tree is filtered to nodes whose name or token contains the query string, with ancestor module paths preserved. Modules with no matching children are omitted. Supports content negotiation via the Accept header: send 'text/markdown' to receive a plain-text listing instead of s" }, { "info": { "name": "GetPackageReadme", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/registry/packages/:source/:publisher/:name/versions/:version/readme", "params": [ { "name": "source", "value": "", "type": "path", "description": "The package source: 'pulumi', 'opentofu', or 'private'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the package" }, { "name": "name", "value": "", "type": "path", "description": "The package name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string or 'latest'" }, { "name": "lang", "value": "", "type": "query", "description": "Filter language-specific content to a single language. Values: typescript, python, go, csharp, java, yaml" }, { "name": "os", "value": "", "type": "query", "description": "Filter OS-specific content to a single OS. Values: linux, macos, windows" } ] }, "docs": "Returns README content for a registry package version, structured as an ordered list of content nodes. Each node has a 'kind' and a 'markdown' fallback for forward compatibility. Use the 'lang' parameter to filter language-specific content to a single language (fallback chain: requested language, then Go, then first available). Use the 'os' parameter to filter OS-specific content similarly (fallback: Linux). Supports content negotiation via the Accept header: send 'text/markdown' to receive a cl" }, { "info": { "name": "ListTemplates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/registry/templates", "params": [ { "name": "continuationToken", "value": "", "type": "query", "description": "Pagination token for retrieving the next page of results" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return (default: 100)" }, { "name": "name", "value": "", "type": "query", "description": "Filter by specific template name" }, { "name": "orgLogin", "value": "", "type": "query", "description": "Filter by owning organization" }, { "name": "search", "value": "", "type": "query", "description": "Search query matching template name, display name, description, metadata values, or runtime language. Multiple space-separated terms require all terms to match (AND semantics)." } ] }, "docs": "Lists registry-backed templates with optional filtering, search, and pagination. This endpoint returns only registry-backed templates and does not include VCS-backed templates (those sourced from GitHub or GitLab repositories). No authentication is required. Results can be filtered by template name and owning organization (orgLogin). The search parameter performs case-insensitive partial matching against the template name, display name, description, metadata values, and runtime language. Results" }, { "info": { "name": "ListTemplateVersions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/registry/templates/:source/:publisher/:name/versions", "params": [ { "name": "source", "value": "", "type": "path", "description": "The template source: 'private', 'github', or 'gitlab'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the template" }, { "name": "name", "value": "", "type": "path", "description": "The template name" }, { "name": "continuationToken", "value": "", "type": "query", "description": "Pagination token for retrieving the next page of results" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return (default: 100)" } ] }, "docs": "Lists all versions of a specific template, ordered by version descending (latest first). The template is identified by its source, publisher organization, and name. Results are paginated with a default limit of 100 per page. Use the continuationToken from the response to retrieve subsequent pages. Each entry in the response contains the template version metadata. Returns 400 for an invalid continuationToken or 404 if the template does not exist." }, { "info": { "name": "PostPublishTemplateVersion", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/registry/templates/:source/:publisher/:name/versions", "params": [ { "name": "source", "value": "", "type": "path", "description": "The template source: 'private', 'github', or 'gitlab'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the template" }, { "name": "name", "value": "", "type": "path", "description": "The template name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the first step of a two-phase template version publish workflow. This creates a publish transaction and returns an operationID along with a pre-signed upload URL for the template archive. The source must be 'private'. The caller must upload the template archive (a gzip-compressed tar file containing a root-level Pulumi.yaml with a template section, and optionally a README.md) to the provided URL, then call PostPublishTemplateVersionComplete with the operationID to finalize the publish." }, { "info": { "name": "GetTemplateVersion", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/registry/templates/:source/:publisher/:name/versions/:version", "params": [ { "name": "source", "value": "", "type": "path", "description": "The template source: 'private', 'github', or 'gitlab'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the template" }, { "name": "name", "value": "", "type": "path", "description": "The template name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string or 'latest'" } ] }, "docs": "Retrieves metadata for a specific version of a registry template. The template is identified by its source (e.g. 'private', 'github', or 'gitlab'), publisher organization, and name. The version parameter accepts either a specific semantic version string or the special value 'latest' to retrieve the most recent version. The response includes the template's name, display name, description, runtime information, language, readme URL, download URL (a pre-signed URL valid for at least 5 minutes for re" }, { "info": { "name": "DeleteTemplateVersion", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/registry/templates/:source/:publisher/:name/versions/:version", "params": [ { "name": "source", "value": "", "type": "path", "description": "The template source: 'private', 'github', or 'gitlab'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the template" }, { "name": "name", "value": "", "type": "path", "description": "The template name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string of the template version to delete" }, { "name": "force", "value": "", "type": "query", "description": "When true, allows deletion of the final remaining template version" } ] }, "docs": "Removes a specific version of a template from the registry. The template is identified by its source (e.g. 'private', 'github', or 'gitlab'), publisher organization, name, and semantic version. If this is the last remaining version of the template, the 'force' query parameter must be set to true; doing so will also delete the template itself. Returns 204 No Content on success, or 400 if an invalid query parameter is provided." }, { "info": { "name": "PostPublishTemplateVersionComplete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/registry/templates/:source/:publisher/:name/versions/:version/complete", "params": [ { "name": "source", "value": "", "type": "path", "description": "The template source: 'private', 'github', or 'gitlab'" }, { "name": "publisher", "value": "", "type": "path", "description": "Organization that owns the template" }, { "name": "name", "value": "", "type": "path", "description": "The template name" }, { "name": "version", "value": "", "type": "path", "description": "Semantic version string of the template version to complete" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Finalizes the second step of the two-phase template version publish workflow. After initiating a publish with PostPublishTemplateVersion and uploading the template archive (.tar.gz) to the pre-signed URL, call this endpoint with the operationID to complete the publish. The service validates that the archive was uploaded successfully before making the version available in the registry. Once complete, the template becomes available to the publisher's organization. Returns 201 Created on success, 4" } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "GetCurrentUser", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/user" }, "docs": "Returns the authenticated user's profile information, including login name, display name, email, avatar URL, and organization memberships." }, { "info": { "name": "ListGitHubOrganizationTeams", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/user/github/:ghOrgName/teams", "params": [ { "name": "ghOrgName", "value": "", "type": "path", "description": "The GitHub organization name" } ] }, "docs": "ListGitHubOrganizationTeams returns all GitHub teams the requesting user has access to see." }, { "info": { "name": "GetGroupsForGitLabApp", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/user/gitlab-app/organizations" }, "docs": "Gets a list of GitLab groups available to be used with the Pulumi GitLab app.\nThis endpoint explicitly denotes which groups can be used based on the\nuser's permissions within each group." }, { "info": { "name": "GetDefaultOrganization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/user/organizations/default" }, "docs": "GetDefaultOrganization returns the default organization for the current user." }, { "info": { "name": "UpdateDefaultOrganization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/user/organizations/:orgName/default", "params": [ { "name": "orgName", "value": "", "type": "path", "description": "The organization name" } ] }, "docs": "UpdateDefaultOrganization sets the default organization for the current user." }, { "info": { "name": "GetLatestPendingEmailChange", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/user/pending-emails" }, "docs": "GetLatestPendingEmailChange returns only the latest email change,\nthat is pending. Returns a 204 if no pending email change requests exist." }, { "info": { "name": "DeletePendingEmailChange", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/user/pending-emails" }, "docs": "DeletePendingEmailChange removes the pending email change for the currently logged-in user.\nDeletes the pending verification only if it isn't a verification record for the current primary email itself." }, { "info": { "name": "ListUserOrgInvites", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/user/pending-invites" }, "docs": "ListUserOrgInvites lists the pending invites for the requesting user." }, { "info": { "name": "ListUserStacks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/user/stacks", "params": [ { "name": "continuationToken", "value": "", "type": "query", "description": "Token from a previous response to fetch the next page of results" }, { "name": "maxResults", "value": "", "type": "query", "description": "Maximum number of stacks to return per page" }, { "name": "organization", "value": "", "type": "query", "description": "Filter stacks to those owned by this organization" }, { "name": "project", "value": "", "type": "query", "description": "Filter stacks to those in this project" }, { "name": "roleID", "value": "", "type": "query", "description": "List stacks only using this custom role" }, { "name": "tagName", "value": "", "type": "query", "description": "Filter stacks by tag name (use with tagValue for exact match)" }, { "name": "tagValue", "value": "", "type": "query", "description": "Filter stacks by tag value (requires tagName)" } ] }, "docs": "Lists all stacks accessible to the authenticated user. Results can be filtered by organization, project, and stack tags (tagName/tagValue). Supports pagination via continuationToken and maxResults parameters. Returns stack summary information including name, project, last update status, and resource count." }, { "info": { "name": "ListPersonalTokens", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/user/tokens", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filter tokens by name or description" } ] }, "docs": "Returns all personal access tokens for the authenticated user. Web-session generated tokens (type 'web') are excluded from the results. Each token in the response includes its ID, description, and lastUsed timestamp. Use the filter query parameter to search tokens by name or description." }, { "info": { "name": "CreatePersonalToken", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/user/tokens", "params": [ { "name": "reason", "value": "", "type": "query", "description": "Tracks the context that triggered token creation (e.g., redirect URL or referral source)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "DeletePersonalToken", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/user/tokens/:tokenId", "params": [ { "name": "tokenId", "value": "", "type": "path", "description": "The access token identifier" } ] }, "docs": "Permanently deletes a personal access token by its identifier. The token is immediately invalidated and can no longer be used for authentication. Returns 204 on success or 404 if the token does not exist." }, { "info": { "name": "DeleteIdentityProvider", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/user/vcs", "params": [ { "name": "identity", "value": "", "type": "query", "description": "The VCS identity provider to disconnect (e.g., github, gitlab, bitbucket)" } ] }, "docs": "DeleteIdentityProvider removes a VCS identity provider from the current user's account." }, { "info": { "name": "ListIdentityProviderOrganizations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/user/vcs/organizations" }, "docs": "ListIdentityProviderOrganizations lists all of the organizations from a backing VCS visible to the Pulumi Service\nfor the requesting user. Ignores errors if this user doesn't have a specific backing identity." }, { "info": { "name": "SyncWithIdentityProvider", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/user/vcs/sync", "params": [ { "name": "identity", "value": "", "type": "query", "description": "The VCS identity provider to sync profile data from (e.g., github, gitlab)" } ] }, "docs": "SyncWithIdentityProvider contacts the requesting user's identity provider,\nand updates their profile information (display name, avatar URL, etc.)\nThis is required since we don't get update events from the identity provider\nwhen changes are made in the identity provider's system." }, { "info": { "name": "GetUserHasVerifiedEmail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/user/verified-email" }, "docs": "GetUserHasVerifiedEmail returns a success response if the user has a verified email,\n404 not found if they are not verified" } ] } ], "bundled": true }