---
title: "Register service"
method: POST
path: "/api/oianalytics/register"
tags: ["OIAnalytics Registration"]
---

# Register service

`POST /api/oianalytics/register`

Registers the current instance of OIBus with the OIAnalytics service

## Request body

- RegistrationSettingsCommandDTO — Registration settings command DTO. Used as the request body for updating registration settings.
  - `host` string, required — The host URL for registration.
  - `useProxy` boolean, required — Whether to use a proxy for registration.
  - `proxyUrl` string, nullable, required — The proxy URL for registration.
  - `proxyUsername` string, nullable, required — The username for proxy authentication.
  - `proxyPassword` string, nullable, required — The password for proxy authentication.
  - `useApiGateway` boolean, required — Whether to use an API Gateway
  - `apiGatewayHeaderKey` string, nullable, required — The header key for the API gateway
  - `apiGatewayHeaderValue` string, nullable, required — The header value (a secret) used for the API gateway
  - `apiGatewayBaseEndpoint` string, nullable, required — The base endpoint used by the API gateway
  - `acceptUnauthorized` boolean, required — Whether to accept unauthorized certificates.
  - `commandRefreshInterval` number, double, required — The interval in seconds for refreshing commands.
  - `commandRetryInterval` number, double, required — The interval in seconds for retrying commands.
  - `messageRetryInterval` number, double, required — The interval in seconds for retrying messages.
  - `commandPermissions` object, required — Permissions for various commands.
    - `testCustomTransformer` boolean, required — Permission to test a custom transformer.
    - `deleteCustomTransformer` boolean, required — Permission to delete a custom transformer.
    - `updateCustomTransformer` boolean, required — Permission to update a custom transformer.
    - `createCustomTransformer` boolean, required — Permission to create a custom transformer.
    - `updateNorthCacheContent` boolean, required — Permission to remove cache content.
    - `getNorthCacheFileContent` boolean, required — Permission to get cache file content.
    - `searchNorthCacheContent` boolean, required — Permission to search cache content.
    - `updateHistoryCacheContent` boolean, required — Permission to remove cache content.
    - `getHistoryCacheFileContent` boolean, required — Permission to get cache file content.
    - `searchHistoryCacheContent` boolean, required — Permission to search cache content.
    - `setpoint` boolean, required — Permission to apply setpoints.
    - `testNorthConnection` boolean, required — Permission to test a north connection.
    - `deleteNorth` boolean, required — Permission to delete a north connector.
    - `updateNorth` boolean, required — Permission to update a north connector.
    - `createNorth` boolean, required — Permission to create a north connector.
    - `testSouthItem` boolean, required — Permission to test a south item.
    - `testSouthConnection` boolean, required — Permission to test a south connection.
    - `createOrUpdateSouthItemsFromCsv` boolean, required — Permission to create or update south items from CSV.
    - `deleteSouth` boolean, required — Permission to delete a south connector.
    - `updateSouth` boolean, required — Permission to update a south connector.
    - `createSouth` boolean, required — Permission to create a south connector.
    - `testHistorySouthItem` boolean, required — Permission to test a history south item.
    - `testHistorySouthConnection` boolean, required — Permission to test a history south connection.
    - `testHistoryNorthConnection` boolean, required — Permission to test a history north connection.
    - `createOrUpdateHistoryItemsFromCsv` boolean, required — Permission to create or update history items from CSV.
    - `deleteHistoryQuery` boolean, required — Permission to delete a history query.
    - `updateHistoryQuery` boolean, required — Permission to update a history query.
    - `createHistoryQuery` boolean, required — Permission to create a history query.
    - `deleteCertificate` boolean, required — Permission to delete a certificate.
    - `updateCertificate` boolean, required — Permission to update a certificate.
    - `createCertificate` boolean, required — Permission to create a certificate.
    - `deleteIpFilter` boolean, required — Permission to delete an IP filter.
    - `updateIpFilter` boolean, required — Permission to update an IP filter.
    - `createIpFilter` boolean, required — Permission to create an IP filter.
    - `deleteScanMode` boolean, required — Permission to delete a scan mode.
    - `updateScanMode` boolean, required — Permission to update a scan mode.
    - `createScanMode` boolean, required — Permission to create a scan mode.
    - `updateRegistrationSettings` boolean, required — Permission to update registration settings.
    - `updateEngineSettings` boolean, required — Permission to update engine settings.
    - `regenerateCipherKeys` boolean, required — Permission to regenerate cipher keys.
    - `restartEngine` boolean, required — Permission to restart the engine.
    - `updateVersion` boolean, required — Permission to update the engine version.

## Response `204`

Registration completed successfully

---

[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)