Collectors

This API resource provides insights into the Cisco CSPC or OIC collectors you have enabled on your network. This one is used to validate how often data is uploaded and when the last upload occurred successfully. These are the resources:

• /collectors
• /collectors/:applianceId

NOTE: If any data the API returns seems outdated, this should be the first place to look at. Are the collectors actively and successfully uploading data to Cisco? If so, is the data older or more recent than the scheduled collection frequency in days?

You can query the /collectors endpoint and it will return you output similar to this example:

{
    "items": [
        {
            "applianceId": "CSP0009031587",
            "collectorName": "bci2",
            "collectorStatus": "Cisco Testing",
            "collectorVersion": "2.8.1.8",
            "expectedUploadInterval": 8,
            "lastUploadTimestamp": "2022-02-03T21:10:58"
        },
        {
            "applianceId": "CSP0009017243",
            "collectorName": "lok1",
            "collectorStatus": "Cisco Testing",
            "collectorVersion": "2.8.1.9",
            "expectedUploadInterval": 8,
            "lastUploadTimestamp": "2022-02-03T20:39:56"
        }
    ]
}

This network has two collectors: lok1 and bci2. They both have their own applicanceId and are performing a full collector upload every 8 days. Their status' are both set to Cisco Testing, which indicates they are not yet considered in production. Once in production, the status will be Active. Their lastUpload was the evening of 2022-02-03 around 9pm.