Get Collectors

Get Collectors

If no filters set, the API returns all the Collectors registered with the VMware Cloud Foundation Operations system

Request
URI
GET
https://{api_host}/suite-api/api/collectors
COPY
Query Parameters
string of array
host
Optional

Optional list of host names to filter by

Authentication
This operation uses the following authentication methods.
Responses
200

The Collectors managed by the system

Returns collectors of type(s) application/json 
"{\n  \"collector\" : [ {\n    \"name\" : \"A Local Collector\",\n    \"state\" : \"UP\",\n    \"local\" : true,\n    \"adapterInstanceIds\" : [ \"a9cb42b9-4d22-49b9-b14f-d15d48457982\", \"dec42fae-acf5-4af9-8fda-b4999f4de9b3\" ],\n    \"dataPersistenceEnabled\" : false,\n    \"id\" : \"1\",\n    \"uuId\" : \"8a22ef38-a9f1-4aa0-9940-f5845be1f9dc\"\n  }, {\n    \"name\" : \"A Remote Collector\",\n    \"state\" : \"DOWN\",\n    \"local\" : false,\n    \"adapterInstanceIds\" : [ \"57a3d411-4b9b-436f-8467-cc7bb39185d2\" ],\n    \"dataPersistenceEnabled\" : false,\n    \"id\" : \"2\"\n  } ]\n}"
array of object
collector
Optional

Collection of collector infos


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/collectors
On This Page
Collectors Operations
PUT
Enable Data Persistence
PUT
Disable Data Persistence
GET
Get Collectors
GET
Get Adapters On Collector