North Connectors

List all north connectors

Changed on

Retrieves a list of all configured north connectors

get/api/north

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/north
  • Auth: none required

Response

Array of north connector objects

idstring required

The unique identifier of the entity.

createdAtstring required

Represents an instant in time as an ISO 8601 string.

updatedAtstring required

Represents an instant in time as an ISO 8601 string.

namestring required

The name of the North connector.

type'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'rest' | 'sftp' | 'aws-s3' | 'azure-blob' | 'azure-data-explorer' | 'console' | 'file-writer' required

Type representing the possible types for a North connector.

descriptionstring required

The description of the North connector.

enabledboolean required

Whether the North connector is enabled.

Example response

[
  {
    "id": "entity123",
    "createdBy": {
      "id": "abc123",
      "friendlyName": "John Doe (john.doe)"
    },
    "updatedBy": {
      "id": "abc123",
      "friendlyName": "John Doe (john.doe)"
    },
    "createdAt": "2023-10-31T12:34:56.789Z",
    "updatedAt": "2023-10-31T12:34:56.789Z",
    "name": "Debug Console Output",
    "description": "Outputs data to console for debugging purposes",
    "enabled": true
  }
]

Changes

  • 0df3f625a5c2Revision changes
    • warning

      added the new azure-data-explorer enum value to the / response property for the response status

  • 21b34a490fa3Revision changes
    • info

      removed the azure-data-explorer enum value from the / response property for the response status