Sigma REST APIDeployment policies{deploymentPolicyId}

Update a deployment policy (Beta)

View as MarkdownOpen in Claude
Update a deployment policy. Only the fields included in the request are changed. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint. - Retrieve the identifier for `sourceSwapPolicies` by calling the [/v2/sourceSwapPolicies](https://help.sigmacomputing.com/reference/list-source-swap-policies) endpoint and using the `policyId` in the response. - The version tag cannot be changed after a deployment policy is created.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

deploymentPolicyIdstringRequired

Request

The request body.
namestringOptional
Name of the deployment policy.
nameInTenantstringOptional
Name to use for the workspace created by the deployment policy in the receiving tenant.
sourceSwapPolicieslist of stringsOptional
Unique identifiers of the source swap policies used to swap connections when deploying documents. Replaces the existing set.
copyInputTableDatabooleanOptional
Whether to copy input table data to receiving tenant organizations when deploying documents. Only applies to input tables that are editable in draft mode.

Response

The response body.
deploymentPolicyIdstring
namestring
Name of the deployment policy
nameInTenantstring
Name to use for the workspace created by the deployment policy in the receiving tenant.
versionTagIdstring or null
sourceSwapPolicieslist of strings
Unique identifiers of the source swap policies used to swap connections when deploying documents.
copyInputTableDataboolean
Whether input table data is copied to receiving tenant organizations when deploying documents. Only applies to input tables that are editable in draft mode.