Deployment policies

Create a deployment policy

Create a deployment policy to define what documents to deploy to a tenant organization and how to swap sources for those documents.

Usage notes

  • Retrieve the versionTagId by calling the /v2/tags endpoint.
  • Retrieve the identifier for sourceSwapPolicies by calling the /v2/sourceSwapPolicies endpoint and using the policyId in the response.
post/v2/deploymentPolicies

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Request body

namestring required

Name of the deployment policy.

versionTagIdstring
sourceSwapPoliciesstring[]

Unique identifiers of the source swap policies used to swap connections when deploying documents.

nameInTenantstring

Name to use for the workspace created by the deployment policy in the receiving tenant.

copyInputTableDataboolean

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.

useDependenciesWorkspaceboolean

Whether to place implicit dependencies in a different workspace, separate from the deployment workspace. Defaults to false.

Response

The response body.

deploymentPolicyIdstring required

Changes

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