Get a source swap policy (Beta)

GET

/v2/sourceSwapPolicies/:policyId

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. Getting details for a Deployment source swap policy is in public beta. 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. Getting details for a **Deployment** source swap policy is in public beta. 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.

policyIdstring

typeenum

namestring

Name of the source swap policy.

fromConnectionIdstring

ID of the connection to swap.

swapsobject

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

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