DataConnectors

Get Data Connectors

get

If no role_id is provided, return all Data Connectors. If role_id is provided, return only the Data Connectors that the role has permission to access.

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Query parameters

role_idany ofOptional

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/api/v1/data_connectors

HTTPcURLJavaScriptPython

GET /api/v1/data_connectors HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create Data Connector

post

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Body

application/json

data_connector_typestringRequired

nameany ofOptional

stringOptional

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

connector_modeany ofOptional

stringOptional

or

nullOptional

annotationsany ofOptional

or

nullOptional

collector_interval_secondsany ofOptional

integerOptional

or

nullOptional

dataconnector_tagsany ofOptional

stringOptional

or

nullOptional

dataconnector_tags_metaany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

post

/api/v1/data_connectors

HTTPcURLJavaScriptPython

POST /api/v1/data_connectors HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 322

{
  "data_connector_type": "text",
  "name": "text",
  "description": "text",
  "connector_mode": "text",
  "config_details": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "annotations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "collector_interval_seconds": 1,
  "dataconnector_tags": "text",
  "dataconnector_tags_meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Get Data Connector

get

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

connector_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/api/v1/data_connectors/{connector_id}

HTTPcURLJavaScriptPython

GET /api/v1/data_connectors/{connector_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Data Connector

put

Persist the edits and update in running containers

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

connector_idintegerRequired

Body

application/json

data_connector_typeany ofOptional

stringOptional

or

nullOptional

nameany ofOptional

stringOptional

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

connector_modeany ofOptional

stringOptional

or

nullOptional

config_detailsany ofOptional

or

nullOptional

annotationsany ofOptional

or

nullOptional

collector_interval_secondsany ofOptional

integerOptional

or

nullOptional

dataconnector_tagsany ofOptional

stringOptional

or

nullOptional

dataconnector_tags_metaany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

put

/api/v1/data_connectors/{connector_id}

HTTPcURLJavaScriptPython

PUT /api/v1/data_connectors/{connector_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 322

{
  "data_connector_type": "text",
  "name": "text",
  "description": "text",
  "connector_mode": "text",
  "config_details": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "annotations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "collector_interval_seconds": 1,
  "dataconnector_tags": "text",
  "dataconnector_tags_meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Delete Data Connector

delete

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

connector_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

delete

/api/v1/data_connectors/{connector_id}

HTTPcURLJavaScriptPython

DELETE /api/v1/data_connectors/{connector_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Data Connector

patch

Persist the edits and update in running containers

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

connector_idintegerRequired

Body

application/json

data_connector_typeany ofOptional

stringOptional

or

nullOptional

nameany ofOptional

stringOptional

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

connector_modeany ofOptional

stringOptional

or

nullOptional

config_detailsany ofOptional

or

nullOptional

annotationsany ofOptional

or

nullOptional

collector_interval_secondsany ofOptional

integerOptional

or

nullOptional

dataconnector_tagsany ofOptional

stringOptional

or

nullOptional

dataconnector_tags_metaany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

patch

/api/v1/data_connectors/{connector_id}

HTTPcURLJavaScriptPython

PATCH /api/v1/data_connectors/{connector_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 322

{
  "data_connector_type": "text",
  "name": "text",
  "description": "text",
  "connector_mode": "text",
  "config_details": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "annotations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "collector_interval_seconds": 1,
  "dataconnector_tags": "text",
  "dataconnector_tags_meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Deactivate Data Connector

post

Stop the Docker container and mark status='exited'. If already not running, this is a no-op.

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

connector_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

post

/api/v1/data_connectors/{connector_id}/deactivate

HTTPcURLJavaScriptPython

POST /api/v1/data_connectors/{connector_id}/deactivate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Activate Data Connector

post

Start (or restart) the collector container and mark status='running'.

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

connector_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

post

/api/v1/data_connectors/{connector_id}/activate

HTTPcURLJavaScriptPython

POST /api/v1/data_connectors/{connector_id}/activate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Validate Connector

post

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Body

application/json

data_connector_typestringRequired

Responses

200

Successful Response

application/json

successbooleanRequired

codeany ofOptional

stringOptional

or

nullOptional

messageany ofOptional

stringOptional

or

nullOptional

field_errorsany ofOptional

or

nullOptional

detailsany ofOptional

or

nullOptional

422

Validation Error

application/json

post

/api/v1/data_connectors/validate

HTTPcURLJavaScriptPython

POST /api/v1/data_connectors/validate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "data_connector_type": "text",
  "config_details": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "success": true,
  "code": "text",
  "message": "text",
  "field_errors": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "details": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}