VCS Integrations

UpdateCustomVCSIntegration

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.

patch/api/console/orgs/{orgName}/integrations/custom/{integrationId}

Request

  • Base URL: https://api.pulumi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pulumi.com/api/console/orgs/{orgName}/integrations/custom/{integrationId}
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

integrationIdstring required

The custom VCS integration identifier

Request body

baseUrlstring

Updated URL prefix for repositories covered by this integration

environmentstring

Updated ESC environment reference in 'project/envName' format

namestring

Updated human-readable name for the integration

regenerateWebhookSecretboolean

When true, generates a new webhook HMAC secret and invalidates the previous one. The new secret is returned in the response.

Response

OK

baseUrlstring required

URL prefix for repositories covered by this integration

createdstring required

ISO 8601 timestamp of when the integration was created

environmentstring required

ESC environment reference in 'project/envName' format containing VCS credentials

idstring required

Unique identifier (UUID) for this integration

modifiedstring required

ISO 8601 timestamp of when the integration was last modified

namestring required

Human-readable name for the integration

vcsType'git' | 'hg' required

Version control system type

webhookSecretstring

HMAC secret for webhook signature verification. Only returned on integration creation; subsequent GET requests omit this field.

webhookUrlstring

Full webhook endpoint URL that the external VCS should POST events to. This URL is generated by the service and includes the integration ID.

Changes

No recorded changes to this operation across all 1 revision of this API.