Query container collectors

GET /container/<containerId>/collectors?fields=...

Description

Query all collectors for a given container. (only enabled collectors are included).

Path parameters

Param	Description
containerId	Container Id.

Query parameters

Param	Default	Description
fields	key	Fields to return (see fields below for all available 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).

Fields

Field	Return type	Description
key	string	Collector Id.
name	string	Collector name.
kind	string	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	Default value (The default value is not guaranteed to pass the validation function).

Return codes

Error code	Reason
200	Success.
400	Unknown field.
401	Invalid or missing token.
403	Insufficient permissions (required: API+READ).
404	Container not found.

Example

Curl request:

curl \
    -X GET 'https://api.infrasonar.com/container/123/collectors?fields=key,kind&options=key,type,default' \
    -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'

Response:

[
    {
        "key": "wmi",
        "kind": "probe",
        "options": [
            {
                "key": "address",
                "type": "String",
                "default": "",
            }
        ]
    }
]