Sign in
North Connectors

List all north connectors

Retrieves a list of all configured north connectors

get/api/north

Response

Array of north connector objects

idstring required

The unique identifier of the entity.

createdBystring

The login of the user who created the entity.

updatedBystring

The login of the user who last updated the entity.

createdAtstring

Represents an instant in time as an ISO 8601 string.

updatedAtstring

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' | '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": "admin",
    "updatedBy": "admin",
    "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