OIAnalytics Registration

Retrieve registration settings

Changed on

Returns the current OIAnalytics registration settings

get/api/oianalytics/registration

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/oianalytics/registration
  • Auth: none required

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": {
    "updateVersion": true,
    "restartEngine": true,
    "regenerateCipherKeys": true,
    "updateEngineSettings": true,
    "importConfiguration": true,
    "dumpMemory": true,
    "retrieveLogsDatabase": true,
    "updateRegistrationSettings": true,
    "createScanMode": true,
    "updateScanMode": true,
    "deleteScanMode": true,
    "createIpFilter": true,
    "updateIpFilter": true,
    "deleteIpFilter": true,
    "createCertificate": true,
    "updateCertificate": true,
    "deleteCertificate": true,
    "createHistoryQuery": true,
    "updateHistoryQuery": true,
    "deleteHistoryQuery": true,
    "createOrUpdateHistoryItemsFromCsv": true,
    "testHistoryNorthConnection": true,
    "testHistorySouthConnection": true,
    "testHistorySouthItem": true,
    "createSouth": true,
    "updateSouth": true,
    "deleteSouth": true,
    "createOrUpdateSouthItemsFromCsv": true,
    "testSouthConnection": true,
    "testSouthItem": true,
    "createNorth": true,
    "updateNorth": true,
    "deleteNorth": true,
    "testNorthConnection": true,
    "setpoint": true,
    "searchHistoryCacheContent": true,
    "getHistoryCacheFileContent": true,
    "updateHistoryCacheContent": true,
    "searchNorthCacheContent": true,
    "getNorthCacheFileContent": true,
    "updateNorthCacheContent": true,
    "createCustomTransformer": true,
    "updateCustomTransformer": true,
    "deleteCustomTransformer": true,
    "testCustomTransformer": true
  }
}

Changes

  • 0df3f625a5c2Revision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 21b34a490fa3Revision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status