POST
/
api
/
platforms
/
v1
curl --request POST \
  --url https://developer.synq.io/api/platforms/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "platform": {
    "unknown": {},
    "bigquery": {
      "project": "<string>"
    },
    "clickhouse": {
      "host": "<string>",
      "schema": "<string>"
    },
    "snowflake": {
      "account": "<string>",
      "database": "<string>"
    },
    "redshift": {
      "cluster": "<string>",
      "database": "<string>"
    },
    "postgres": {
      "host": "<string>",
      "database": "<string>"
    },
    "mysql": {
      "host": "<string>"
    },
    "databricks": {
      "workspace": "<string>"
    },
    "dbtCloud": {
      "apiEndpoint": "<string>",
      "accountId": "<string>",
      "projectId": "<string>"
    },
    "sqlMesh": {
      "defaultDatabaseInstance": "<string>"
    },
    "duckdb": {
      "motherduckAccount": "<string>"
    },
    "trino": {
      "coordinator": "<string>"
    },
    "synqIntegrationId": "<string>"
  },
  "authentication": {
    "token": {
      "token": "<string>"
    },
    "oauth": {
      "clientId": "<string>",
      "clientSecret": "<string>"
    },
    "password": {
      "username": "<string>",
      "password": "<string>"
    },
    "synqManagedKeyPair": {
      "publicKey": "<string>"
    },
    "userManagedKeyPair": {
      "privateKey": "<string>"
    }
  }
}'
{
  "success": true,
  "authentication": {
    "token": {
      "token": "<string>"
    },
    "oauth": {
      "clientId": "<string>",
      "clientSecret": "<string>"
    },
    "password": {
      "username": "<string>",
      "password": "<string>"
    },
    "synqManagedKeyPair": {
      "publicKey": "<string>"
    },
    "userManagedKeyPair": {
      "privateKey": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Response

200
application/json

OK

The response is of type object.