GET
/
api
/
entities
/
v1
/
{id}
curl --request GET \
  --url https://developer.synq.io/api/entities/v1/{id} \
  --header 'Authorization: Bearer <token>'
{
  "entity": {
    "workspace": "<string>",
    "id": {
      "dbtCoreNode": {
        "integrationId": "<string>",
        "nodeId": "<string>"
      },
      "dbtCloudNode": {
        "projectId": "<string>",
        "accountId": "<string>",
        "nodeId": "<string>"
      },
      "bigqueryTable": {
        "project": "<string>",
        "dataset": "<string>",
        "table": "<string>"
      },
      "snowflakeTable": {
        "account": "<string>",
        "database": "<string>",
        "schema": "<string>",
        "table": "<string>"
      },
      "redshiftTable": {
        "cluster": "<string>",
        "database": "<string>",
        "schema": "<string>",
        "table": "<string>"
      },
      "postgresTable": {
        "host": "<string>",
        "database": "<string>",
        "schema": "<string>",
        "table": "<string>"
      },
      "mysqlTable": {
        "host": "<string>",
        "schema": "<string>",
        "table": "<string>"
      },
      "clickhouseTable": {
        "host": "<string>",
        "schema": "<string>",
        "table": "<string>"
      },
      "airflowDag": {
        "integrationId": "<string>",
        "dagId": "<string>"
      },
      "airflowTask": {
        "integrationId": "<string>",
        "dagId": "<string>",
        "taskId": "<string>"
      },
      "custom": {
        "id": "<string>"
      },
      "dataproduct": {
        "id": "<string>"
      },
      "synqPath": {
        "path": "<string>"
      },
      "databricksTable": {
        "workspace": "<string>",
        "catalog": "<string>",
        "schema": "<string>",
        "table": "<string>"
      },
      "trinoTable": {
        "host": "<string>",
        "catalog": "<string>",
        "schema": "<string>",
        "table": "<string>"
      },
      "sqlMeshModel": {
        "integrationId": "<string>",
        "fqn": "<string>"
      },
      "sqlMeshAudit": {
        "integrationId": "<string>",
        "fqn": "<string>",
        "auditId": "<string>"
      },
      "monitor": {
        "monitoredId": {},
        "monitorId": "<string>",
        "segment": "<string>",
        "integrationId": "<string>"
      }
    },
    "typeId": 123,
    "name": "<string>",
    "description": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "synqPath": "<string>",
    "synqCatalogUrl": "<string>",
    "annotations": [
      {
        "name": "<string>",
        "values": [
          "<string>"
        ]
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
object
required

Identifier of the entity to get.

Response

200
application/json

OK

GetEntityResponse is the response message for the GetEntity method.