UpdateIntegration

curl --request PUT \
  --url https://developer.synq.io/api/integrations/v1/{integration_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {
    "athena": {
      "accessKey": {
        "accessKeyId": "<string>",
        "secretAccessKey": "<string>"
      },
      "region": "<string>",
      "workgroup": "<string>",
      "useShowCreateTable": true,
      "useShowCreateView": true,
      "fetchQueryLogs": true,
      "useIcebergMetricsScan": true,
      "scope": {
        "include": [
          {
            "database": "<string>",
            "schema": "<string>",
            "table": "<string>"
          }
        ],
        "exclude": [
          {
            "database": "<string>",
            "schema": "<string>",
            "table": "<string>"
          }
        ]
      }
    }
  },
  "title": "<string>",
  "etag": "<string>"
}
'

import requests

url = "https://developer.synq.io/api/integrations/v1/{integration_id}"

payload = {
    "config": { "athena": {
            "accessKey": {
                "accessKeyId": "<string>",
                "secretAccessKey": "<string>"
            },
            "region": "<string>",
            "workgroup": "<string>",
            "useShowCreateTable": True,
            "useShowCreateView": True,
            "fetchQueryLogs": True,
            "useIcebergMetricsScan": True,
            "scope": {
                "include": [
                    {
                        "database": "<string>",
                        "schema": "<string>",
                        "table": "<string>"
                    }
                ],
                "exclude": [
                    {
                        "database": "<string>",
                        "schema": "<string>",
                        "table": "<string>"
                    }
                ]
            }
        } },
    "title": "<string>",
    "etag": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    config: {
      athena: {
        accessKey: {accessKeyId: '<string>', secretAccessKey: '<string>'},
        region: '<string>',
        workgroup: '<string>',
        useShowCreateTable: true,
        useShowCreateView: true,
        fetchQueryLogs: true,
        useIcebergMetricsScan: true,
        scope: {
          include: [{database: '<string>', schema: '<string>', table: '<string>'}],
          exclude: [{database: '<string>', schema: '<string>', table: '<string>'}]
        }
      }
    },
    title: '<string>',
    etag: '<string>'
  })
};

fetch('https://developer.synq.io/api/integrations/v1/{integration_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developer.synq.io/api/integrations/v1/{integration_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'config' => [
        'athena' => [
                'accessKey' => [
                                'accessKeyId' => '<string>',
                                'secretAccessKey' => '<string>'
                ],
                'region' => '<string>',
                'workgroup' => '<string>',
                'useShowCreateTable' => true,
                'useShowCreateView' => true,
                'fetchQueryLogs' => true,
                'useIcebergMetricsScan' => true,
                'scope' => [
                                'include' => [
                                                                [
                                                                                                                                'database' => '<string>',
                                                                                                                                'schema' => '<string>',
                                                                                                                                'table' => '<string>'
                                                                ]
                                ],
                                'exclude' => [
                                                                [
                                                                                                                                'database' => '<string>',
                                                                                                                                'schema' => '<string>',
                                                                                                                                'table' => '<string>'
                                                                ]
                                ]
                ]
        ]
    ],
    'title' => '<string>',
    'etag' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://developer.synq.io/api/integrations/v1/{integration_id}"

	payload := strings.NewReader("{\n  \"config\": {\n    \"athena\": {\n      \"accessKey\": {\n        \"accessKeyId\": \"<string>\",\n        \"secretAccessKey\": \"<string>\"\n      },\n      \"region\": \"<string>\",\n      \"workgroup\": \"<string>\",\n      \"useShowCreateTable\": true,\n      \"useShowCreateView\": true,\n      \"fetchQueryLogs\": true,\n      \"useIcebergMetricsScan\": true,\n      \"scope\": {\n        \"include\": [\n          {\n            \"database\": \"<string>\",\n            \"schema\": \"<string>\",\n            \"table\": \"<string>\"\n          }\n        ],\n        \"exclude\": [\n          {\n            \"database\": \"<string>\",\n            \"schema\": \"<string>\",\n            \"table\": \"<string>\"\n          }\n        ]\n      }\n    }\n  },\n  \"title\": \"<string>\",\n  \"etag\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://developer.synq.io/api/integrations/v1/{integration_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config\": {\n    \"athena\": {\n      \"accessKey\": {\n        \"accessKeyId\": \"<string>\",\n        \"secretAccessKey\": \"<string>\"\n      },\n      \"region\": \"<string>\",\n      \"workgroup\": \"<string>\",\n      \"useShowCreateTable\": true,\n      \"useShowCreateView\": true,\n      \"fetchQueryLogs\": true,\n      \"useIcebergMetricsScan\": true,\n      \"scope\": {\n        \"include\": [\n          {\n            \"database\": \"<string>\",\n            \"schema\": \"<string>\",\n            \"table\": \"<string>\"\n          }\n        ],\n        \"exclude\": [\n          {\n            \"database\": \"<string>\",\n            \"schema\": \"<string>\",\n            \"table\": \"<string>\"\n          }\n        ]\n      }\n    }\n  },\n  \"title\": \"<string>\",\n  \"etag\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/integrations/v1/{integration_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"config\": {\n    \"athena\": {\n      \"accessKey\": {\n        \"accessKeyId\": \"<string>\",\n        \"secretAccessKey\": \"<string>\"\n      },\n      \"region\": \"<string>\",\n      \"workgroup\": \"<string>\",\n      \"useShowCreateTable\": true,\n      \"useShowCreateView\": true,\n      \"fetchQueryLogs\": true,\n      \"useIcebergMetricsScan\": true,\n      \"scope\": {\n        \"include\": [\n          {\n            \"database\": \"<string>\",\n            \"schema\": \"<string>\",\n            \"table\": \"<string>\"\n          }\n        ],\n        \"exclude\": [\n          {\n            \"database\": \"<string>\",\n            \"schema\": \"<string>\",\n            \"table\": \"<string>\"\n          }\n        ]\n      }\n    }\n  },\n  \"title\": \"<string>\",\n  \"etag\": \"<string>\"\n}"

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

{
  "integration": {
    "id": "<string>",
    "title": "<string>",
    "disabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "etag": "<string>",
    "config": {
      "athena": {
        "accessKey": {
          "accessKeyId": "<string>",
          "secretAccessKey": "<string>"
        },
        "region": "<string>",
        "workgroup": "<string>",
        "useShowCreateTable": true,
        "useShowCreateView": true,
        "fetchQueryLogs": true,
        "useIcebergMetricsScan": true,
        "scope": {
          "include": [
            {
              "database": "<string>",
              "schema": "<string>",
              "table": "<string>"
            }
          ],
          "exclude": [
            {
              "database": "<string>",
              "schema": "<string>",
              "table": "<string>"
            }
          ]
        }
      }
    },
    "outputs": {
      "athena": {
        "accountId": "<string>",
        "principalArn": "<string>"
      }
    },
    "capabilities": {
      "canPatch": true,
      "canRefresh": true,
      "canDisable": true,
      "canEnable": true,
      "canDelete": true,
      "isDwh": true,
      "canReconcileDeploy": true
    }
  }
}

synq.integrations.v1.IntegrationsService

UpdateIntegration

Update an integration. The config is replaced wholesale — send the complete desired config (omitted secrets are preserved; see the service-level secret semantics). title is patch-style: omit it to leave it unchanged.

The config variant must match the existing integration’s type; changing the type is rejected with FAILED_PRECONDITION.

Safe to retry: addresses an existing id and converges to the same state. With an etag set, a retry after success returns ABORTED (the version moved) — treat that as “already applied”.

PUT

api

integrations

{integration_id}

UpdateIntegration

curl --request PUT \
  --url https://developer.synq.io/api/integrations/v1/{integration_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {
    "athena": {
      "accessKey": {
        "accessKeyId": "<string>",
        "secretAccessKey": "<string>"
      },
      "region": "<string>",
      "workgroup": "<string>",
      "useShowCreateTable": true,
      "useShowCreateView": true,
      "fetchQueryLogs": true,
      "useIcebergMetricsScan": true,
      "scope": {
        "include": [
          {
            "database": "<string>",
            "schema": "<string>",
            "table": "<string>"
          }
        ],
        "exclude": [
          {
            "database": "<string>",
            "schema": "<string>",
            "table": "<string>"
          }
        ]
      }
    }
  },
  "title": "<string>",
  "etag": "<string>"
}
'

import requests

url = "https://developer.synq.io/api/integrations/v1/{integration_id}"

payload = {
    "config": { "athena": {
            "accessKey": {
                "accessKeyId": "<string>",
                "secretAccessKey": "<string>"
            },
            "region": "<string>",
            "workgroup": "<string>",
            "useShowCreateTable": True,
            "useShowCreateView": True,
            "fetchQueryLogs": True,
            "useIcebergMetricsScan": True,
            "scope": {
                "include": [
                    {
                        "database": "<string>",
                        "schema": "<string>",
                        "table": "<string>"
                    }
                ],
                "exclude": [
                    {
                        "database": "<string>",
                        "schema": "<string>",
                        "table": "<string>"
                    }
                ]
            }
        } },
    "title": "<string>",
    "etag": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    config: {
      athena: {
        accessKey: {accessKeyId: '<string>', secretAccessKey: '<string>'},
        region: '<string>',
        workgroup: '<string>',
        useShowCreateTable: true,
        useShowCreateView: true,
        fetchQueryLogs: true,
        useIcebergMetricsScan: true,
        scope: {
          include: [{database: '<string>', schema: '<string>', table: '<string>'}],
          exclude: [{database: '<string>', schema: '<string>', table: '<string>'}]
        }
      }
    },
    title: '<string>',
    etag: '<string>'
  })
};

fetch('https://developer.synq.io/api/integrations/v1/{integration_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developer.synq.io/api/integrations/v1/{integration_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'config' => [
        'athena' => [
                'accessKey' => [
                                'accessKeyId' => '<string>',
                                'secretAccessKey' => '<string>'
                ],
                'region' => '<string>',
                'workgroup' => '<string>',
                'useShowCreateTable' => true,
                'useShowCreateView' => true,
                'fetchQueryLogs' => true,
                'useIcebergMetricsScan' => true,
                'scope' => [
                                'include' => [
                                                                [
                                                                                                                                'database' => '<string>',
                                                                                                                                'schema' => '<string>',
                                                                                                                                'table' => '<string>'
                                                                ]
                                ],
                                'exclude' => [
                                                                [
                                                                                                                                'database' => '<string>',
                                                                                                                                'schema' => '<string>',
                                                                                                                                'table' => '<string>'
                                                                ]
                                ]
                ]
        ]
    ],
    'title' => '<string>',
    'etag' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://developer.synq.io/api/integrations/v1/{integration_id}"

	payload := strings.NewReader("{\n  \"config\": {\n    \"athena\": {\n      \"accessKey\": {\n        \"accessKeyId\": \"<string>\",\n        \"secretAccessKey\": \"<string>\"\n      },\n      \"region\": \"<string>\",\n      \"workgroup\": \"<string>\",\n      \"useShowCreateTable\": true,\n      \"useShowCreateView\": true,\n      \"fetchQueryLogs\": true,\n      \"useIcebergMetricsScan\": true,\n      \"scope\": {\n        \"include\": [\n          {\n            \"database\": \"<string>\",\n            \"schema\": \"<string>\",\n            \"table\": \"<string>\"\n          }\n        ],\n        \"exclude\": [\n          {\n            \"database\": \"<string>\",\n            \"schema\": \"<string>\",\n            \"table\": \"<string>\"\n          }\n        ]\n      }\n    }\n  },\n  \"title\": \"<string>\",\n  \"etag\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://developer.synq.io/api/integrations/v1/{integration_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config\": {\n    \"athena\": {\n      \"accessKey\": {\n        \"accessKeyId\": \"<string>\",\n        \"secretAccessKey\": \"<string>\"\n      },\n      \"region\": \"<string>\",\n      \"workgroup\": \"<string>\",\n      \"useShowCreateTable\": true,\n      \"useShowCreateView\": true,\n      \"fetchQueryLogs\": true,\n      \"useIcebergMetricsScan\": true,\n      \"scope\": {\n        \"include\": [\n          {\n            \"database\": \"<string>\",\n            \"schema\": \"<string>\",\n            \"table\": \"<string>\"\n          }\n        ],\n        \"exclude\": [\n          {\n            \"database\": \"<string>\",\n            \"schema\": \"<string>\",\n            \"table\": \"<string>\"\n          }\n        ]\n      }\n    }\n  },\n  \"title\": \"<string>\",\n  \"etag\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/integrations/v1/{integration_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"config\": {\n    \"athena\": {\n      \"accessKey\": {\n        \"accessKeyId\": \"<string>\",\n        \"secretAccessKey\": \"<string>\"\n      },\n      \"region\": \"<string>\",\n      \"workgroup\": \"<string>\",\n      \"useShowCreateTable\": true,\n      \"useShowCreateView\": true,\n      \"fetchQueryLogs\": true,\n      \"useIcebergMetricsScan\": true,\n      \"scope\": {\n        \"include\": [\n          {\n            \"database\": \"<string>\",\n            \"schema\": \"<string>\",\n            \"table\": \"<string>\"\n          }\n        ],\n        \"exclude\": [\n          {\n            \"database\": \"<string>\",\n            \"schema\": \"<string>\",\n            \"table\": \"<string>\"\n          }\n        ]\n      }\n    }\n  },\n  \"title\": \"<string>\",\n  \"etag\": \"<string>\"\n}"

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

{
  "integration": {
    "id": "<string>",
    "title": "<string>",
    "disabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "etag": "<string>",
    "config": {
      "athena": {
        "accessKey": {
          "accessKeyId": "<string>",
          "secretAccessKey": "<string>"
        },
        "region": "<string>",
        "workgroup": "<string>",
        "useShowCreateTable": true,
        "useShowCreateView": true,
        "fetchQueryLogs": true,
        "useIcebergMetricsScan": true,
        "scope": {
          "include": [
            {
              "database": "<string>",
              "schema": "<string>",
              "table": "<string>"
            }
          ],
          "exclude": [
            {
              "database": "<string>",
              "schema": "<string>",
              "table": "<string>"
            }
          ]
        }
      }
    },
    "outputs": {
      "athena": {
        "accountId": "<string>",
        "principalArn": "<string>"
      }
    },
    "capabilities": {
      "canPatch": true,
      "canRefresh": true,
      "canDisable": true,
      "canEnable": true,
      "canDelete": true,
      "isDwh": true,
      "canReconcileDeploy": true
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integration_id

string<uuid>

required

Id of the integration to update (UUID).

Body

application/json

Request to update an integration. The config is replaced wholesale; title is patch-style (omit to leave unchanged).

config

athena · object

required

New connection configuration. The populated config variant must match the existing integration's type.

Show child attributes

title

string | null

New human-friendly name. Omit to leave the title unchanged.

Required string length: 1 - 255

etag

string | null

Optional optimistic-concurrency guard. When set, the update is applied only if it matches the integration's current etag; otherwise ABORTED (HTTP 409). Omit for last-write-wins.

Response

200 - application/json

Success

Response from updating an integration.

integration

Integration · object

The updated integration with a new etag.

Show child attributes

BatchGetIntegrations DeleteIntegration

Get Started

Alerts

Monitors

Monitors Types

Data Products

Scout AI

Ownership

Incidents

Analytics

Lineage

BI Integrations

Data Warehouse Integrations

Transactional databases

Code Integrations

dbt Integrations

SQLMesh Integrations

Coalesce Integrations

Orchestration Tool Integrations

Alerting Integrations

Catalogs

Google Cloud Integrations

Admin

Security

Support

Developer API

UpdateIntegration

Authorizations

Path Parameters

Body

Response