Get Started
Monitors
Incidents
Analytics
Data Warehouse Integrations
SQLMesh Integrations
Orchestration Tool Integrations
Alerting Integrations
Catalogs
Security
Support
Developer API
- Getting Started
- REST API
- ChangesService
- CodeService
- DatabaseCoordinatesService
- SqlTestsService
- TestSuggestionsService
- DwhService
- EntitiesService
- EntityExecutionsService
- AtlanIntegrationService
- AtlanProviderService
- AtlanWorkflowService
- CommitsService
- ImpactService
- IncidentsService
- IssuesService
- LineageService
- DeploymentRulesService
- HistoryService
- MonitorInfoService
- PlatformsService
- SchemasService
- EntityIncidentsService
- EntityIssuesService
- TriageService
- gRPC API
- Webhooks
PlatformsService
Post apiplatformsv1
POST
/
api
/
platforms
/
v1
Copy
Ask AI
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>"
}
}
}'
Copy
Ask AI
{
"success": true,
"authentication": {
"token": {
"token": "<string>"
},
"oauth": {
"clientId": "<string>",
"clientSecret": "<string>"
},
"password": {
"username": "<string>",
"password": "<string>"
},
"synqManagedKeyPair": {
"publicKey": "<string>"
},
"userManagedKeyPair": {
"privateKey": "<string>"
}
}
}
Authorizations
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
.
Copy
Ask AI
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>"
}
}
}'
Copy
Ask AI
{
"success": true,
"authentication": {
"token": {
"token": "<string>"
},
"oauth": {
"clientId": "<string>",
"clientSecret": "<string>"
},
"password": {
"username": "<string>",
"password": "<string>"
},
"synqManagedKeyPair": {
"publicKey": "<string>"
},
"userManagedKeyPair": {
"privateKey": "<string>"
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.