v51

OpenAPI 3.0.0EUPLraw.githubusercontent.com2026-08-01133591927.1 KB

OIAnalytics Registration

Test connection

Test connection to OIAnalytics service with the provided settings

post/api/oianalytics/registration/test-connection

Request body

hoststring required

The host URL for registration.

useProxyboolean required

Whether to use a proxy for registration.

proxyUrlstring nullable required

The proxy URL for registration.

proxyUsernamestring nullable required

The username for proxy authentication.

proxyPasswordstring nullable required

The password for proxy authentication.

useApiGatewayboolean required

Whether to use an API Gateway

apiGatewayHeaderKeystring nullable required

The header key for the API gateway

apiGatewayHeaderValuestring nullable required

The header value (a secret) used for the API gateway

apiGatewayBaseEndpointstring nullable required

The base endpoint used by the API gateway

acceptUnauthorizedboolean required

Whether to accept unauthorized certificates.

commandRefreshIntervalnumber double required

The interval in seconds for refreshing commands.

commandRetryIntervalnumber double required

The interval in seconds for retrying commands.

messageRetryIntervalnumber double required

The interval in seconds for retrying messages.

Example request

{
  "host": "https://instance.oianalytics.com",
  "commandRefreshInterval": 60,
  "commandRetryInterval": 10,
  "messageRetryInterval": 10,
  "commandPermissions": {
    "testCustomTransformer": true,
    "deleteCustomTransformer": true,
    "updateCustomTransformer": true,
    "createCustomTransformer": true,
    "updateNorthCacheContent": true,
    "getNorthCacheFileContent": true,
    "searchNorthCacheContent": true,
    "updateHistoryCacheContent": true,
    "getHistoryCacheFileContent": true,
    "searchHistoryCacheContent": true,
    "setpoint": true,
    "testNorthConnection": true,
    "deleteNorth": true,
    "updateNorth": true,
    "createNorth": true,
    "testSouthItem": true,
    "testSouthConnection": true,
    "createOrUpdateSouthItemsFromCsv": true,
    "deleteSouth": true,
    "updateSouth": true,
    "createSouth": true,
    "testHistorySouthItem": true,
    "testHistorySouthConnection": true,
    "testHistoryNorthConnection": true,
    "createOrUpdateHistoryItemsFromCsv": true,
    "deleteHistoryQuery": true,
    "updateHistoryQuery": true,
    "createHistoryQuery": true,
    "deleteCertificate": true,
    "updateCertificate": true,
    "createCertificate": true,
    "deleteIpFilter": true,
    "updateIpFilter": true,
    "createIpFilter": true,
    "deleteScanMode": true,
    "updateScanMode": true,
    "createScanMode": true,
    "updateRegistrationSettings": true,
    "updateEngineSettings": true,
    "regenerateCipherKeys": true,
    "restartEngine": true,
    "updateVersion": true
  }
}

Response

Connection test successful