Connector License Status API

<< Click to Display Table of Contents >>

Raynet One Data Hub > 2025.4 > Administration and User Guide > Advanced Topics > Data API 

Connector License Status API

An API endpoint is present in DataHub to retrieve connector license and status information for a specific tenant.

 

Endpoint Details

Base Information

HTTP Method: GET

Endpoint: http://v1/Collectors/getByTenantId

Full URL: http://[host]:[port]/v1/Collectors/getByTenantId

Authentication: None required

 

papercliper

Note: The endpoint is rate-limited to a maximum of 10 requests per minute.

 

Request Parameters

Query Parameters

tenantId (required) → tenantId of the tenant

onlyLicensed → Filters connectors to include only licensed connectors

onlyEnabled → Filters connectors to include only those that are enabled

 

Response

The endpoint returns information about connectors, indicating:

Which connectors are licensed

Which connectors are unlicensed

Connector enabled status (when applicable)

 

Example Requests

Get All Connectors for a Tenant

GET http://[host]:[port]/v1/Collectors/getByTenantId?tenantId=5A8A3ECC-E668-472F-B163-497920A35CEF

 

Get Only Licensed Connectors

GET http://[host]:[port]/v1/Collectors/getByTenantId?tenantId=5A8A3ECC-E668-472F-B163-497920A35CEF&onlyLicensed=true

 

Get Only Enabled Connectors

GET http://[host]:[port]/v1/Collectors/getByTenantId?tenantId=5A8A3ECC-E668-472F-B163-497920A35CEF&onlyEnabled=true

 

Get Licensed and Enabled Connectors

GET http://[host]:[port]/v1/Collectors/getByTenantId?tenantId=5A8A3ECC-E668-472F-B163-497920A35CEF&onlyLicensed=true&onlyEnabled=true

 

papercliper

Note: The endpoint does not require any credentials or API keys. Only the tenant ID is necessary to make a request.