---
title: "Test north connection"
method: POST
path: "/api/north/{northId}/test/connection"
tags: ["North Connectors"]
---

# Test north connection

`POST /api/north/{northId}/test/connection`

Tests the connection for a north connector

## Path parameters

- `northId` string, required

## Query parameters

- `northType` 'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'rest' | 'sftp' | 'aws-s3' | 'azure-blob' | 'console' | 'file-writer', required — Type representing the possible types for a North connector.

## Request body

- union
  - NorthAmazonS3Settings
    - `bucket` string, required
    - `region` string, required
    - `folder` string, required
    - `accessKey` string, required
    - `secretKey` string, nullable, required
    - `useProxy` boolean, required
    - `proxyUrl` string, nullable
    - `proxyUsername` string, nullable
    - `proxyPassword` string, nullable
  - NorthAzureBlobSettings
    - `useADLS` boolean, required
    - `useCustomUrl` boolean, required
    - `account` string
    - `customUrl` string
    - `container` string, required
    - `path` string, required
    - `authentication` 'access-key' | 'sas-token' | 'aad' | 'external', required
    - `accessKey` string, nullable
    - `sasToken` string, nullable
    - `tenantId` string, nullable
    - `clientId` string, nullable
    - `clientSecret` string, nullable
    - `useProxy` boolean, required
    - `proxyUrl` string
    - `proxyUsername` string, nullable
    - `proxyPassword` string, nullable
  - NorthConsoleSettings
    - `verbose` boolean, required
  - NorthFileWriterSettings
    - `outputFolder` string, required
    - `prefix` string, nullable, required
    - `suffix` string, nullable, required
    - `username` string, nullable
    - `password` string, nullable
    - `domain` string, nullable
  - NorthModbusSettings
    - `host` string, required
    - `port` number, double, required
    - `connectTimeout` number, double, required
    - `retryInterval` number, double, required
    - `slaveId` number, double, required
    - `addressOffset` 'modbus' | 'jbus', required
    - `endianness` 'big-endian' | 'little-endian', required
    - `swapBytesInWords` boolean, required
    - `swapWordsInDWords` boolean, required
  - NorthMQTTSettings
    - `url` string, required
    - `qos` '0' | '1' | '2', required
    - `persistent` boolean
    - `authentication` NorthMQTTSettingsAuthentication, required
      - `type` 'none' | 'basic' | 'cert', required
      - `username` string
      - `password` string, nullable
      - `certFilePath` string
      - `keyFilePath` string
      - `caFilePath` string
    - `rejectUnauthorized` boolean, required
    - `reconnectPeriod` number, double, required
    - `connectTimeout` number, double, required
  - NorthOIAnalyticsSettings
    - `useOiaModule` boolean, required
    - `timeout` number, double, required
    - `compress` boolean, required
    - `specificSettings` NorthOIAnalyticsSettingsSpecificSettings
      - `host` string, required
      - `acceptUnauthorized` boolean, required
      - `authentication` 'basic' | 'aad-client-secret' | 'aad-certificate', required
      - `accessKey` string
      - `secretKey` string, nullable
      - `tenantId` string, nullable
      - `clientId` string
      - `clientSecret` string, nullable
      - `certificateId` string, nullable
      - `scope` string, nullable
      - `useProxy` boolean, required
      - `proxyUrl` string
      - `proxyUsername` string, nullable
      - `proxyPassword` string, nullable
  - NorthOPCUASettings
    - `url` string, required
    - `keepSessionAlive` boolean, required
    - `retryInterval` number, double, required
    - `securityMode` 'none' | 'sign' | 'sign-and-encrypt', required
    - `securityPolicy` 'none' | 'basic128' | 'basic192' | 'basic256' | 'basic128-rsa15' | 'basic192-rsa15' | 'basic256-rsa15' | 'basic256-sha256' | 'aes128-sha256-rsa-oaep' | 'pub-sub-aes-128-ctr' | 'pub-sub-aes-256-ctr'
    - `authentication` NorthOPCUASettingsAuthentication, required
      - `type` 'none' | 'basic' | 'cert', required
      - `username` string
      - `password` string, nullable
      - `certFilePath` string
      - `keyFilePath` string
  - NorthRESTSettings
    - `host` string, required
    - `acceptUnauthorized` boolean, required
    - `method` 'POST' | 'PUT' | 'PATCH', required
    - `endpoint` string, required
    - `timeout` number, double, required
    - `sendAs` 'file' | 'body', required
    - `successCode` number, double, required
    - `authentication` NorthRESTSettingsAuthentication, required
      - `type` 'none' | 'basic' | 'bearer' | 'api-key', required
      - `username` string
      - `password` string, nullable
      - `token` string, nullable
      - `apiKey` string
      - `apiValue` string, nullable
      - `addTo` 'header' | 'query-params'
    - `proxy` NorthRESTSettingsProxy, required
      - `useProxy` boolean, required
      - `proxyUrl` string
      - `proxyUsername` string, nullable
      - `proxyPassword` string, nullable
    - `queryParams` NorthRESTSettingsQueryParams[], required
      - `key` string, required
      - `value` string, required
    - `headers` NorthRESTSettingsHeaders[], required
      - `key` string, required
      - `value` string, required
    - `test` NorthRESTSettingsTest, required
      - `testMethod` 'GET' | 'POST' | 'PUT', required
      - `testEndpoint` string, required
      - `body` string, nullable
      - `testSuccessCode` number, double, required
  - NorthSFTPSettings
    - `host` string, required
    - `port` number, double, required
    - `authentication` 'password' | 'private-key', required
    - `username` string, required
    - `password` string, nullable
    - `privateKey` string
    - `passphrase` string, nullable
    - `remoteFolder` string, required
    - `prefix` string, nullable, required
    - `suffix` string, nullable, required

## Response `200`

Ok

- OIBusConnectionTestResult
  - `items` object[], required
    - `value` string, required
    - `key` string, required

---

[API](https://skmtc.net/optimistiksas/apis/oibus-api.md) · [All operations](https://skmtc.net/optimistiksas/apis/oibus-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/optimistiksas/oibus-api/revisions/fe8fd32c9fdc/schema)