Connector APIs

List of APIs to manage data input connectors

Connector Config APIs

Dataset Source Config APIs allow you to configure the sources for a dataset. You can add sources, update, list and retrieve the existing source configuration for a dataset.

API to configure a new connector/source for a dataset.

POST<Your-Host-IP>:3000/datasets/v1/source/config/create

Body

application/json

idstring

dataset_idstring

connector_typestring

connector_configobject

statusstring

connector_statsobject

created_bystring

updated_bystring

published_datestring

Response

200400409

OK

Body

application/json

idstring

verstring

tsinteger

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('<Your-Host-IP>:3000/datasets/v1/source/config/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "dataset_id": "obsrv-telemetry-events",
      "connector_type": "kafka",
      "connector_config": {
        "type": "kafka",
        "topic": "telemetry.input",
        "kafkaBrokers": "localhost:9092"
      },
      "status": "Live",
      "published_date": "2023-03-24 12:19:32.091544"
    }),
});
const data = await response.json();

Response

{
  "id": "obsrv.config.dataset.source.config.create",
  "ver": "v1",
  "ts": 1679916559382,
  "params": {
    "status": "SUCCESS",
    "errmsg": "text"
  },
  "responseCode": "OK",
  "result": {
    "message": "The dataset configuration has been saved successfully",
    "id": "obsrv-telemetry-events_kafka"
  }
}

API to update any changes with respect to existing sources for a dataset.

PATCH<Your-Host-IP>:3000/datasets/v1/source/config/update

Body

application/json

idstring

dataset_idstring

connector_typestring

connector_configobject

statusstring

connector_statsobject

created_bystring

updated_bystring

published_datestring

Response

200400

OK

Body

application/json

idstring

verstring

tsinteger

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('<Your-Host-IP>:3000/datasets/v1/source/config/update', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "dataset_id": "obsrv-telemetry-events",
      "connector_type": "kafka",
      "connector_config": {
        "type": "kafka",
        "topic": "telemetry.ingest",
        "kafkaBrokers": "localhost:9092"
      },
      "status": "Live"
    }),
});
const data = await response.json();

Response

{
  "id": "obsrv.config.dataset.source.config.update",
  "ver": "v1",
  "ts": 1679916559382,
  "params": {
    "status": "SUCCESS",
    "errmsg": "text"
  },
  "responseCode": "OK",
  "result": {
    "message": "The dataset configuration has been updated successfully",
    "id": "obsrv-telemetry-events_kafka"
  }
}

API to get details on the sources configured for a specific dataset

GET<Your-Host-IP>:3000/datasets/v1/source/config/get/{datasetId}

Path parameters

datasetId*string

Response

200404

OK

Body

application/json

idstring

verstring

tsstring

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('<Your-Host-IP>:3000/datasets/v1/source/config/get/{datasetId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "obsrv.config.dataset.source.config.read",
  "ver": "v1",
  "ts": 1672679516875,
  "params": {
    "status": "SUCCESS",
    "errmsg": "text"
  },
  "responseCode": "OK",
  "result": {
    "id": "obsrv-telemetry-events_kafka",
    "connector_type": "kafka",
    "connector_config": {
      "type": "kafka",
      "topic": "local.ingest",
      "kafkaBrokers": "localhost:9092"
    },
    "status": "Live",
    "connector_stats": {},
    "created_by": "SYSTEM",
    "updated_by": "SYSTEM",
    "created_date": "2023-05-11T18:30:00.000Z",
    "updated_date": "2023-05-11T18:30:00.000Z",
    "published_date": "2023-05-11T18:30:00.000Z",
    "dataset_id": "obsrv-telemetry-events"
  }
}

API to list all the sources configured within Obsrv.

POST<Your-Host-IP>:3000/datasets/v1/source/config/list

Body

application/json

filtersobject

Response

200400

OK

Body

application/json

idstring

verstring

tsstring

paramsobject

responseCodestring

resultarray of object

Request

JavaScriptCurl

const response = await fetch('<Your-Host-IP>:3000/datasets/v1/source/config/list', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filters": {
        "status": [
          "Live",
          "Retired"
        ]
      }
    }),
});
const data = await response.json();

Response

{
  "id": "obsrv.config.dataset.source.config.list",
  "ver": "v1",
  "ts": 1672679516875,
  "params": {
    "status": "SUCCESS",
    "errmsg": "text"
  },
  "responseCode": "OK",
  "result": [
    {
      "id": "obsrv-telemetry-events_kafka",
      "connector_type": "kafka",
      "connector_config": {
        "type": "kafka",
        "topic": "local.ingest",
        "kafkaBrokers": "localhost:9092"
      },
      "status": "Live",
      "connector_stats": {},
      "created_by": "SYSTEM",
      "updated_by": "SYSTEM",
      "created_date": "2023-05-11T18:30:00.000Z",
      "updated_date": "2023-05-11T18:30:00.000Z",
      "published_date": "2023-05-11T18:30:00.000Z",
      "dataset_id": "obsrv-telemetry-events"
    }
  ]
}