Get a source swap policy | Sigma Documentation

Get a source swap policy by policy ID.

Beta: Getting details for a Connection source swap policy is in private beta and must be enabled for your organization. This documentation is subject to the Beta features disclaimer.

Usage notes

Retrieve the policyId by calling the /v2/sourceSwapPolicies endpoint.

Get a source swap policy by policy ID. **Beta**: Getting details for a **Connection** source swap policy is in private beta and must be enabled for your organization. This documentation is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the **policyId** by calling the [/v2/sourceSwapPolicies](https://help.sigmacomputing.com/reference/list-source-swap-policies) endpoint.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

policyIdstringRequired

Response

The response body.

Connection swapobject

Deployment swapobject

1	{
2	"fromConnectionId": "string",
3	"name": "string",
4	"policyId": "string",
5	"swaps": {
6	"connectionSwaps": [
7	{
8	"to": {
9	"path0": {
10	"swapType": "attribute",
11	"userAttributeId": "string"
12	},
13	"path1": {
14	"swapType": "attribute",
15	"userAttributeId": "string"
16	},
17	"path2": {
18	"swapType": "attribute",
19	"userAttributeId": "string"
20	}
21	}
22	}
23	]
24	},
25	"type": "connection"
26	}

$	curl https://api.sigmacomputing.com/v2/sourceSwapPolicies/policyId \
>	-H "Authorization: Bearer <token>"