OIAnalytics Registration

Retrieve registration settings

Returns the current OIAnalytics registration settings

get/api/oianalytics/registration

Response

The registration settings

idstring required

The unique identifier of the entity.

createdAtstring required

Represents an instant in time as an ISO 8601 string.

updatedAtstring required

Represents an instant in time as an ISO 8601 string.

hoststring required

The host URL for registration.

activationCodestring nullable required

The activation code for registration.

status'NOT_REGISTERED' | 'PENDING' | 'REGISTERED' required

Type representing a registration status.

activationDatestring required

Represents an instant in time as an ISO 8601 string.

activationExpirationDatestring

Represents an instant in time as an ISO 8601 string.

checkUrlstring nullable required

The URL to check registration status.

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.

useApiGatewayboolean required

Whether to use an API Gateway

apiGatewayHeaderKeystring nullable required

The header key 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 response

{
  "id": "entity123",
  "createdBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  },
  "updatedBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  },
  "createdAt": "2023-10-31T12:34:56.789Z",
  "updatedAt": "2023-10-31T12:34:56.789Z",
  "host": "https://registration.example.com",
  "activationCode": "ABC123",
  "activationDate": "2023-10-31T12:34:56.789Z",
  "activationExpirationDate": "2023-10-31T12:34:56.789Z",
  "checkUrl": "https://instant.oianalytics.com/check",
  "commandRefreshInterval": 60,
  "commandRetryInterval": 10,
  "messageRetryInterval": 10,
  "commandPermissions": {
    "updateNorthCacheContent": true,
    "getNorthCacheFileContent": true,
    "searchNorthCacheContent": true,
    "updateHistoryCacheContent": true,
    "getHistoryCacheFileContent": true,
    "searchHistoryCacheContent": true,
    "setpoint": true,
    "deleteNorth": true,
    "updateNorth": true,
    "createNorth": true,
    "createOrUpdateSouthItemsFromCsv": true,
    "deleteSouth": true,
    "updateSouth": true,
    "createSouth": 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
  }
}

Changes

Changed in 9 of the 73 revisions of this API.181230

Mar 25, 2026cdb5b7ea719924See the full diff
- ●
  removed the optional property creationDate from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property lastEditInstant from the response with the 200 status
  response-optional-property-removed
- ○
  added the required property createdAt to the response with the 200 status
  response-required-property-added
- ○
  added the required property createdBy to the response with the 200 status
  response-required-property-added
- ○
  added the required property updatedAt to the response with the 200 status
  response-required-property-added
- ○
  added the required property updatedBy to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 20, 2026108013c9462942See the full diff
- ▲
  removed the required property createdAt from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property createdBy from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property updatedAt from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property updatedBy from the response with the 200 status
  response-required-property-removed
- ○
  added the optional property creationDate to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property lastEditInstant to the response with the 200 status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 19, 2026fb56929c067524See the full diff
- ●
  removed the optional property creationDate from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property lastEditInstant from the response with the 200 status
  response-optional-property-removed
- ○
  added the required property createdAt to the response with the 200 status
  response-required-property-added
- ○
  added the required property createdBy to the response with the 200 status
  response-required-property-added
- ○
  added the required property updatedAt to the response with the 200 status
  response-required-property-added
- ○
  added the required property updatedBy to the response with the 200 status
  response-required-property-added
Mar 18, 2026d6e364e3cd4e42See the full diff
- ▲
  removed the required property createdAt from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property createdBy from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property updatedAt from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property updatedBy from the response with the 200 status
  response-required-property-removed
- ○
  added the optional property creationDate to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property lastEditInstant to the response with the 200 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 17, 20263bf1b221f6ef24See the full diff
- ●
  removed the optional property creationDate from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property lastEditInstant from the response with the 200 status
  response-optional-property-removed
- ○
  added the required property createdAt to the response with the 200 status
  response-required-property-added
- ○
  added the required property createdBy to the response with the 200 status
  response-required-property-added
- ○
  added the required property updatedAt to the response with the 200 status
  response-required-property-added
- ○
  added the required property updatedBy to the response with the 200 status
  response-required-property-added
This revision also has 12 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 10, 202688f262299d5e42See the full diff
- ●
  removed the optional property createdAt from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property createdBy from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property updatedAt from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property updatedBy from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property creationDate to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property lastEditInstant to the response with the 200 status
  response-optional-property-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 10, 202676d90b88c3e524See the full diff
- ●
  removed the optional property creationDate from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property lastEditInstant from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property createdAt to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property createdBy to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property updatedAt to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property updatedBy to the response with the 200 status
  response-optional-property-added
This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 19, 2026f7d0cb77f2c542See the full diff
- ▲
  removed the required property commandPermissions/moveHistoryCacheContent from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property commandPermissions/moveNorthCacheContent from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property commandPermissions/removeHistoryCacheContent from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property commandPermissions/removeNorthCacheContent from the response with the 200 status
  response-required-property-removed
- ○
  added the required property commandPermissions/updateHistoryCacheContent to the response with the 200 status
  response-required-property-added
- ○
  added the required property commandPermissions/updateNorthCacheContent to the response with the 200 status
  response-required-property-added
This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 6, 2026d8e7a58e006a66See the full diff
- ▲
  removed the required property commandPermissions/updateHistoryCacheContent from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property commandPermissions/updateNorthCacheContent from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property createdAt from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property createdBy from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property updatedAt from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property updatedBy from the response with the 200 status
  response-required-property-removed
- ○
  added the optional property creationDate to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property lastEditInstant to the response with the 200 status
  response-optional-property-added
- ○
  added the required property commandPermissions/moveHistoryCacheContent to the response with the 200 status
  response-required-property-added
- ○
  added the required property commandPermissions/moveNorthCacheContent to the response with the 200 status
  response-required-property-added
- ○
  added the required property commandPermissions/removeHistoryCacheContent to the response with the 200 status
  response-required-property-added
- ○
  added the required property commandPermissions/removeNorthCacheContent to the response with the 200 status
  response-required-property-added
This revision also has 219 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history