Query collector
GET /collector/<collectorKey>?fields=...
Description
Returns detailed information for a specific collector. By supplying optional query parameters, you can retrieve the collector's full hierarchy in a single request—including its configuration options, checks, check types, and nested metrics (along with their data, format, and reference definitions).
If you only need to inspect a single resource without fetching the entire collector tree, see the dedicated endpoints for querying a check, type, or metric.
Path parameters
| Param | Description |
|---|---|
collectorKey |
Collector key. |
Query parameters
| Param | Default | Description |
|---|---|---|
fields |
all fields | Fields to return (see Fields below for all available fields). |
checks |
none | Check fields. If at least one field is given, the result will include "checks" with an array of check objects (see Check api for all available check fields). |
options |
none | Option fields. If at least one field is given, the result will include "options" with an array of option objects (see Options below for all available option fields). |
types |
none | Type fields. If at least one field is given, the result will include "types" with an array of type objects (see Type api for all available type fields). |
metrics |
none | Metric fields. If at least one field is given, the result will include "metrics" with an array of metric objects (see Metric api for all available metric fields). |
data |
none | Data fields. The result will include "data" with a data object (see Data api for all available data fields). |
format |
none | Format fields. The result will include "format" with a format object (see Format api for all available format fields). |
ref |
none | Ref type fields. The result will include "ref" with a ref object (see Ref api for all available ref fields). |
refs |
none | Ref fields. If at least one field is given, the result will include "refs" with an array of ref objects (see Refs api for all available ref fields). |
Fields
| Field | Return type | Description |
|---|---|---|
key |
string | Collector key. |
name |
string | Collector name. |
kind |
string | Collector kind. One of Agent, Probe or Service. |
info |
string | Collector info. |
minVersion |
string | Minimal required version for the collector. |
checks |
array(string) | Array with check keys. |
Options
| Option field | Return type | Description |
|---|---|---|
key |
string | Option key. |
name |
string | Option name. |
info |
string | Option info. |
type |
string | One of Bool, Int, Float, String, ListBool, ListInt, ListFloat or ListString. |
default |
any | Initial default value (Note that this is only a placeholder/starting value and is not guaranteed to pass validation). |
Return codes
| Error code | Reason |
|---|---|
200 |
Success. |
400 |
Unknown field. |
401 |
Invalid or missing token. |
403 |
Insufficient permissions (required: API+READ). |
404 |
Collector not found. |
Example
Curl request:
curl \
-X GET 'https://api.infrasonar.com/collector/http?fields=key,kind' \
-H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
Response:
{
"key": "http",
"kind": "Probe"
}