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

Register Connector

Registers a connector by uploading a file.

POSThttp://localhost:3000/v2/connector/register

Body

multipart/form-data

file3string (binary)

Connector distribution file to upload.

Response

200500

Connector registered successfully.

Body

application/json

idstring

Example: "api.connector.register"

verstring

Example: "v2"

tsstring (date-time)

Example: "2024-11-19T09:28:47+00:00"

paramsobject

responseCodestring

Example: "OK"

resultobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/v2/connector/register', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200500

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

Read Connector

GEThttp://localhost:3000/v2/connectors/read/{connector_id}

Path parameters

connector_id*string

Unique identifier for the connector

Response

200404

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/v2/connectors/read/{connector_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

List Connectors

POSThttp://localhost:3000/v2/connectors/list

Body

application/json

object

Response

200400

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/v2/connectors/list', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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"
          ]
        }
      }
    }),
});
const data = await response.json();