OIAnalytics Registration

Register service

Registers the current instance of OIBus with the OIAnalytics service

post/api/oianalytics/register

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

Registration completed successfully

Changes

Changed in 3 of the 73 revisions of this API.1010

Mar 25, 2026cdb5b7ea71994See the full diff
- ▲
  added the new required request property commandPermissions/createCustomTransformer
  new-required-request-property
- ▲
  added the new required request property commandPermissions/deleteCustomTransformer
  new-required-request-property
- ▲
  added the new required request property commandPermissions/testCustomTransformer
  new-required-request-property
- ▲
  added the new required request property commandPermissions/updateCustomTransformer
  new-required-request-property
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 19, 2026f7d0cb77f2c524See the full diff
- ▲
  added the new required request property commandPermissions/updateHistoryCacheContent
  new-required-request-property
- ▲
  added the new required request property commandPermissions/updateNorthCacheContent
  new-required-request-property
- ●
  removed the request property commandPermissions/moveHistoryCacheContent
  request-property-removed
- ●
  removed the request property commandPermissions/moveNorthCacheContent
  request-property-removed
- ●
  removed the request property commandPermissions/removeHistoryCacheContent
  request-property-removed
- ●
  removed the request property commandPermissions/removeNorthCacheContent
  request-property-removed
This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 6, 2026d8e7a58e006a46See the full diff
- ▲
  added the new required request property commandPermissions/moveHistoryCacheContent
  new-required-request-property
- ▲
  added the new required request property commandPermissions/moveNorthCacheContent
  new-required-request-property
- ▲
  added the new required request property commandPermissions/removeHistoryCacheContent
  new-required-request-property
- ▲
  added the new required request property commandPermissions/removeNorthCacheContent
  new-required-request-property
- ●
  removed the request property commandPermissions/createCustomTransformer
  request-property-removed
- ●
  removed the request property commandPermissions/deleteCustomTransformer
  request-property-removed
- ●
  removed the request property commandPermissions/testCustomTransformer
  request-property-removed
- ●
  removed the request property commandPermissions/updateCustomTransformer
  request-property-removed
- ●
  removed the request property commandPermissions/updateHistoryCacheContent
  request-property-removed
- ●
  removed the request property commandPermissions/updateNorthCacheContent
  request-property-removed
This revision also has 219 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history