SIsigmacomputing
Deployment policies

Update a deployment policy

Update a deployment policy. Only the fields included in the request are changed.

Usage notes

  • Retrieve the deploymentPolicyId from the /v2/deploymentPolicies endpoint.
  • Retrieve the identifier for sourceSwapPolicies by calling the /v2/sourceSwapPolicies endpoint and using the policyId in the response.
  • The version tag cannot be changed after a deployment policy is created.
patch/v2/deploymentPolicies/{deploymentPolicyId}

Request

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

Path parameters

deploymentPolicyIdstring required

Unique identifier of the deployment policy.

Request body

namestring

Name of the deployment policy.

nameInTenantstring

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

sourceSwapPoliciesstring[]

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

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.

useDependenciesWorkspaceboolean

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

Response

The response body.

deploymentPolicyIdstring required
namestring required

Name of the deployment policy

nameInTenantstring required

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

versionTagIdstring nullable required
sourceSwapPoliciesstring[] required

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

copyInputTableDataboolean required

Whether input table data is copied to receiving tenant organizations when deploying documents. Only applies to input tables that are editable in draft mode.

useDependenciesWorkspaceboolean required

Whether implicit dependencies are placed in a different workspace, separate from the deployment workspace.

Changes

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