Skip to main content
POST
/
api
/
coordinates
/
v1
/
database
/
by-fqn
BatchIdsByCoordinates
curl --request POST \
  --url https://developer.synq.io/api/coordinates/v1/database/by-fqn \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sqlFqn": [
    "<string>"
  ]
}
'
import requests

url = "https://developer.synq.io/api/coordinates/v1/database/by-fqn"

payload = { "sqlFqn": ["<string>"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({sqlFqn: ['<string>']})
};

fetch('https://developer.synq.io/api/coordinates/v1/database/by-fqn', 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/coordinates/v1/database/by-fqn",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sqlFqn' => [
'<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/coordinates/v1/database/by-fqn"

payload := strings.NewReader("{\n \"sqlFqn\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("POST", 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.post("https://developer.synq.io/api/coordinates/v1/database/by-fqn")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sqlFqn\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/coordinates/v1/database/by-fqn")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sqlFqn\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "matchedCoordinates": [
    {
      "sqlFqn": "<string>",
      "candidates": [
        {
          "identifiers": [
            {
              "airflowDag": {
                "integrationId": "<string>",
                "dagId": "<string>"
              }
            }
          ],
          "synqPaths": [
            "<string>"
          ],
          "dialectName": "<string>",
          "dataPlatform": {
            "athena": {
              "instance": "<string>",
              "catalog": "<string>"
            }
          },
          "connectionId": "<string>",
          "instanceName": "<string>",
          "databaseName": "<string>",
          "schemaName": "<string>",
          "objectName": "<string>",
          "sqlFqn": "<string>",
          "sqlDatabaseName": "<string>",
          "sqlSchemaName": "<string>",
          "sqlObjectName": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

application/json
sqlFqn
string[]

Databases coordinates as present in the SQL, e.g. db.schema.table

Response

200 - application/json

Success

matchedCoordinates
MatchedCoordinates · object[]