Skip to main content
POST
/
api
/
integrations
/
v1
CreateIntegration
curl --request POST \
  --url https://developer.synq.io/api/integrations/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<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>"
          }
        ]
      }
    }
  }
}
'
{
  "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.

Body

application/json

Request to create an integration.

​
title
string
required

Human-friendly name for the integration.

Required string length: 1 - 255
​
config
athena · object
required

Connection configuration. Exactly one config variant must be set; it fixes the integration's type.

Response

200 - application/json

Success

Response from creating an integration.

​
integration
Integration · object

The created integration, including its assigned id, etag, and any generated outputs.