Skip to main content
POST
/
api
/
integrations
/
v1
/
{integration_id}
/
disable
DisableIntegration
curl --request POST \
  --url https://developer.synq.io/api/integrations/v1/{integration_id}/disable \
  --header 'Authorization: Bearer <token>'
{
  "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
    }
  }
}

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 disable (UUID).

Response

200 - application/json

Success

Response from disabling an integration.

integration
Integration · object

The integration after disabling.