Connector APIs

List of APIs to manage data input connectors

Connector Config APIs

Connectors are used to ingest data from external sources. It provides a set of APIs to register, list and read connectors configurations API

PreviousDataset Management Console NextData In & Out APIs

Last updated 3 months ago

Was this helpful?

Register Connector

Registers a connector by uploading a file.

post

/v2/connector/register

Body

file3string · binary

Connector distribution file to upload.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:3000/v2/connector/register' \
  --header 'Content-Type: multipart/form-data'

200

500

{
  "id": "api.connector.register",
  "ver": "v2",
  "ts": "2024-11-19T09:28:47+00:00",
  "responseCode": "OK",
  "params": {
    "status": "SUCCESS",
    "resmsgid": "fc2ce24f-a333-479f-931c-024d61039801"
  },
  "result": {
    "message": "connector registered successfully."
  }
}

Connector registered successfully.

Read Connector

get

/v2/connectors/read/{connector_id}

Path parameters

connector_idstringrequired

Unique identifier for the connector

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:3000/v2/connectors/read/{connector_id}'

200

404

Success: Read Draft Connector

Success: Read live Connector

{
  "id": "api.connectors.read",
  "ver": "v2",
  "ts": "2024-08-01T12:47:12+05:30",
  "responseCode": "OK",
  "params": {
    "status": "SUCCESS",
    "resmsgid": "b6fcfb05-246c-4a1b-9eb1-27497ee9b80b"
  },
  "result": {
    "id": "mssql-connector-2.0.0",
    "connector_id": "mssql-connector",
    "name": "MS SQL",
    "type": "source",
    "category": "Database",
    "version": "2.0.0",
    "description": "The MS SQL Connector is used to move data from any MS SQL Table to the Obsrv platform",
    "licence": "MIT",
    "owner": "Sunbird",
    "iconurl": "https://upload.wikimedia.org/wikipedia/commons/2/29/Microsoft_SQL_Server_Logo.svg",
    "status": "Draft",
    "created_by": "SYSTEM",
    "updated_by": "SYSTEM",
    "created_date": "2024-06-25T04:38:28.847Z",
    "updated_date": "2024-06-25T04:38:28.847Z",
    "live_date": "2024-06-25T04:38:28.847Z",
    "ui_spec": {}
  }
}

List Connectors

post

/v2/connectors/list

Body

object

Example:

{"id":"api.connectors.list","ver":"v2","ts":"2024-04-10T16:10:50+05:30","params":{"msgid":"4a7f14c3-d61e-4d4f-be78-181834eeff6d"},"request":{"filters":{"status":["Draft"]}}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:3000/v2/connectors/list' \
  --header 'Content-Type: application/json' \
  --data '{"id":"api.connectors.list","ver":"v2","ts":"2024-04-10T16:10:50+05:30","params":{"msgid":"4a7f14c3-d61e-4d4f-be78-181834eeff6d"},"request":{"filters":{"status":["Draft"]}}}'

200

400

Success: Filtered based on status

Success: Filtered based on category

Success: Connectors list with all filter options

Success: Connectors list without filters

{
  "id": "api.connectors.list",
  "ver": "v2",
  "ts": "2024-07-30T15:25:51+05:30",
  "responseCode": "OK",
  "params": {
    "status": "SUCCESS",
    "msgid": "4a7f14c3-d61e-4d4f-be78-181834eeff6d",
    "resmsgid": "f506e725-eed4-41df-86dc-2477d5c4d19a"
  },
  "result": {
    "count": 0,
    "data": []
  }
}