v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

otCollectorManagementExternal

Get OT Collector by ID.

get/v1/otCollectors/{id}

Path parameters

idstring required

Identifier of the OT Collector to get.

Response

An OT Collector by identifier.

idstring required

Unique identifier of the OT Collector.

namestring required

Name of the OT Collector.

categorystring

Category of the OT Collector.

descriptionstring

Description of the OT Collector.

tagsobject

Tags associated with the OT Collector.

ephemeralboolean

Ephemeral Status of the OT Collector.

aliveboolean

Alive Status of the OT Collector based on heartbeat.

isRemotelyManagedboolean

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

effectiveConfigobject

Config map that includes Base 64 Encoded Effective Configuration Yaml of the Remotely managed OT Collector.

timeZonestring

timezone of the collector

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the resource.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who last modified the resource.

sourceTemplateLinkedCountinteger

Count of the source templates linked to a collector

Example response

{
  "id": "0000000005F5E105",
  "name": "test OT Collector",
  "category": "apache",
  "tags": {
    "team": "app-dev",
    "showIcon": true
  },
  "healthIncidentsTracker": {
    "warningsCount": 1
  },
  "alive": true,
  "isRemotelyManaged": true,
  "effectiveConfig": {
    "00000000000000A3": "ZGVtbyBjb25maWc=",
    "00000000000000D5": "XFVtbfe34tgcvefv="
  },
  "systemInfo": {
    "hostName": "app.test.com",
    "hostOsName": "Linux",
    "hostOsVersion": "5.4.144-69.257.amzn2.x86_64",
    "hostIpAddress": "19.123.24.66",
    "hostEnv": "EKS-1.20.2"
  },
  "timeZone": "UTC",
  "createdAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006A5C7A2",
  "modifiedAt": "2018-10-16T09:10:00Z",
  "modifiedBy": "0000000006A5C7A2",
  "sourceTemplateLinkedCount": 1
}