POST /v1/otCollectors

Given different filter, search and sort conditions, get list of otCollectors.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
filters Object No

parameter which is used for filtering.

filters.isRemotelyManaged Boolean No

Management Status of the OT Collector based on if it is remotely or locally managed.

filters.tags[] Array No

tags associated with the OT collector

filters.os String No

Name of the Operating System.

filters.collectorVersionRange Object No

Version range for otCollector.

filters.collectorVersionRange.maxVersion String No

Maximum version of the collector.

filters.collectorVersionRange.minVersion String No

Minimum version of otCollector.

filters.collectorVersionRange.rangeType String No

Specifies how filtering should be applied when minVersion and maxVersion are defined. - Within: Filtering includes the specified range. - Outside: Filtering excludes the specified range. By default, filtering includes the specified range.

filters.alive Boolean No

alive Status of the OT Collector based on heartbeat.

includeCount Boolean No

count of filtered otCollectors.

limit Integer No

parameter which is used for limiting number of otCollectors on a page.

sortBy String No

parameter which is used for sorting.

search String No

search by collector id or free text search on collector properties.

next String No

parameter which is used for fetching next set of results.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.