Sigma REST APIDeployment policies{deploymentPolicyId}

Create a deployment policy (Beta)

View as MarkdownOpen in Claude
Create a deployment policy to define what documents to deploy to a tenant organization and how to swap sources for those documents. **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 **versionTagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) 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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.
namestringRequired
Name of the deployment policy.
versionTagIdstringOptional
sourceSwapPolicieslist of stringsOptional
Unique identifiers of the source swap policies used to swap connections when deploying documents.
nameInTenantstringOptional
Name to use for the workspace created by the deployment policy in the receiving tenant.
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. Defaults to false.

Response

The response body.
deploymentPolicyIdstring