> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://help.sigmacomputing.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server.

# List source swap policies

GET https://api.sigmacomputing.com/v2/sourceSwapPolicies

Get a list of source swap policies.

  **Beta**: Getting a list of **Connection** source swap policies 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.
    

Reference: https://help.sigmacomputing.com/reference/list-source-swap-policies

## Authentication

- OAuth2 — send the obtained token as `Authorization: Bearer <token>`

## Servers

- `https://api.sigmacomputing.com` (Server for GCP (US) hosted organizations, default)
- `https://api.sa.gcp.sigmacomputing.com` (Server for GCP (KSA) hosted organizations)
- `https://aws-api.sigmacomputing.com` (Server for AWS US (West) hosted organizations)
- `https://api.us-a.aws.sigmacomputing.com` (Server for AWS US (East) hosted organizations)
- `https://api.ca.aws.sigmacomputing.com` (Server for AWS Canada hosted organizations)
- `https://api.eu.aws.sigmacomputing.com` (Server for AWS Europe hosted organizations)
- `https://api.au.aws.sigmacomputing.com` (Server for AWS Australia and APAC hosted organizations)
- `https://api.uk.aws.sigmacomputing.com` (Server for AWS UK hosted organizations)
- `https://api.us.azure.sigmacomputing.com` (Server for Azure US hosted organizations)
- `https://api.eu.azure.sigmacomputing.com` (Server for Azure Europe hosted organizations)
- `https://api.ca.azure.sigmacomputing.com` (Server for Azure Canada hosted organizations)
- `https://api.uk.azure.sigmacomputing.com` (Server for Azure United Kingdom hosted organizations)
- `https://api.au.azure.sigmacomputing.com` (Server for Azure Australia hosted organizations)

## Request

### Query parameters

- `page` (string, optional)
- `limit` (double, optional)

## Response

### 200

The response body.

- `entries` (list of object or object, required)
  - Connection swap
    - `type` (enum, required)
      - Allowed values: `connection`
    - `name` (string, required) — Name of the source swap policy.
    - `fromConnectionId` (string, required) — ID of the connection to swap.
    - `swaps` (object, required)
      - `connectionSwaps` (list of object, required) — Swap paths to a different location in the same connection.
        - `to` (object, required) — Specify how to swap each segment of a path to a table in your database, catalog, or project. `path0` is equivalent to a database, catalog, or project. `path` is equivalent to a schema or dataset, and `path2` is equivalent to a table or view.
          - `path0` (object or object or object, required) — The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed.
            - User attribute
            - Specific path
            - No changes
          - `path1` (object or object or object, required) — The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed.
            - User attribute
            - Specific path
            - No changes
          - `path2` (object or object or object, optional) — The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed.
            - User attribute
            - Specific path
            - No changes
    - `policyId` (string, required)
  - Deployment swap
    - `type` (enum, required)
      - Allowed values: `deployment`
    - `name` (string, required) — Name of the source swap policy.
    - `fromConnectionId` (string, required) — ID of the connection to swap.
    - `swaps` (object, required)
      - `toConnection` (object, required)
        - `swapType` (enum, required) — Specify a user attribute to use the value of the user attribute as the value to swap.
          - Allowed values: `attribute`
        - `userAttributeId` (string, required)
      - `deploymentSwaps` (list of object, required)
        - `from` (object, required)
          - `path0` (object or object, required)
            - No changes
            - Specific path
          - `path1` (object or object, required)
            - No changes
            - Specific path
          - `path2` (object or object, optional)
            - No changes
            - Specific path
        - `to` (object, required)
          - `path0` (object or object or object, required) — The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed.
            - User attribute
            - Specific path
            - No changes
          - `path1` (object or object or object, required) — The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed.
            - User attribute
            - Specific path
            - No changes
          - `path2` (object or object or object, optional) — The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed.
            - User attribute
            - Specific path
            - No changes
    - `policyId` (string, required)
- `nextPage` (string, required, nullable)
- `total` (double, optional)

## Examples

**Response**

```json
{
  "entries": [
    {
      "fromConnectionId": "string",
      "name": "string",
      "policyId": "string",
      "swaps": {
        "connectionSwaps": [
          {
            "to": {
              "path0": {
                "swapType": "attribute",
                "userAttributeId": "string"
              },
              "path1": {
                "swapType": "attribute",
                "userAttributeId": "string"
              },
              "path2": {
                "swapType": "attribute",
                "userAttributeId": "string"
              }
            }
          }
        ]
      },
      "type": "connection"
    }
  ],
  "nextPage": "string",
  "total": 1.1
}
```

**SDK Code**

```python
import requests

url = "https://api.sigmacomputing.com/v2/sourceSwapPolicies"

headers = {"Authorization": "<token>."}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.sigmacomputing.com/v2/sourceSwapPolicies';
const options = {method: 'GET', headers: {Authorization: '<token>.'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sigmacomputing.com/v2/sourceSwapPolicies"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<token>.")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sigmacomputing.com/v2/sourceSwapPolicies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<token>.'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.sigmacomputing.com/v2/sourceSwapPolicies")
  .header("Authorization", "<token>.")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.sigmacomputing.com/v2/sourceSwapPolicies', [
  'headers' => [
    'Authorization' => '<token>.',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sigmacomputing.com/v2/sourceSwapPolicies");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<token>.");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<token>."]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/sourceSwapPolicies")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```