Collectors

The /Collectors resource collection represents all Collectors installed on your Management Server.

Get Collector Hierarchy Tree

The HTTP GET request to the /collectors/collectorsTree endpoint retrieves a hierarchical tree of Collector groups with their Collectors and monitored objects.

SecurityuserAuth

Responses

200

401

Unauthorized

500

Internal Server Error

get/api/v1/collectors/collectorsTree

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

[{"id": "00000000-0000-0000-0000-000000000000",
"name": "Veeam Collectors",
"type": "Root",
"status": null,
"monitoringLoad": null,
"collectionInterval": null,
"children": [{"id": "Default Monitoring Group",
"name": "Default Monitoring Group",
"type": "Group",
"status": "Active",
"monitoringLoad": 42,
"collectionInterval": 300,
"children": [{"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "COLLECTOR-01",
"type": "Collector",
"status": "Active",
"monitoringLoad": 42,
"collectionInterval": 300,
"children": [{"id": "vcenter.lab.local\\u0001domain-c1",
"name": "vcenter.lab.local/Cluster-01",
"type": "Cluster",
"status": null,
"monitoringLoad": null,
"collectionInterval": null,
"children": null,
"issued": null,
"total": null,
"isDefault": false,
"statusIndicator": null
}
],
"issued": null,
"total": null,
"isDefault": false,
"statusIndicator": "Success"
}
],
"issued": 0,
"total": 1,
"isDefault": true,
"statusIndicator": "Success"
}
],
"issued": 0,
"total": 1,
"isDefault": false,
"statusIndicator": null
}
]

Get List of Registered Collectors

The HTTP GET request to the /collectors/collectors endpoint retrieves a list of all registered Collectors with their current status and monitoring load.

SecurityuserAuth

Responses

200

401

Unauthorized

500

Internal Server Error

get/api/v1/collectors/collectors

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

[{"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "COLLECTOR-01",
"status": "Active",
"monitoringLoad": 42
},
{"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "COLLECTOR-02",
"status": "Standby",
"monitoringLoad": 0
}
]

Get All Collector Groups

The HTTP GET request to the /collectors/group endpoint retrieves a list of all Collector groups with their capacity and load statistics.

SecurityuserAuth

Responses

200

401

Unauthorized

500

Internal Server Error

get/api/v1/collectors/groups

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

[{"name": "Default Monitoring Group",
"objectCount": 42,
"availableCollectors": 2,
"monitoringLoad": 42,
"groupCapacity": 200,
"collectorCapacity": 100
},
{"name": "New Group",
"objectCount": 15,
"availableCollectors": 1,
"monitoringLoad": 15,
"groupCapacity": 100,
"collectorCapacity": 100
}
]

Get All Monitoring Jobs

The HTTP GET request to the /collectors/jobs endpoint retrieves a list of all monitoring jobs with their object count and socket usage.

SecurityuserAuth

Responses

200

401

Unauthorized

500

Internal Server Error

get/api/v1/collectors/jobs

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

[{"name": "vcenter.lab.local/Cluster-01",
"objectCount": 30,
"sockets": 8
},
{"name": "esxi-host-02.lab.local/Datastores",
"objectCount": 12,
"sockets": 4
}
]

Move Collector to Different Group

The HTTP POST request to the /collectors/collector/{id}/move endpoint moves a Collector to a different group. Optionally, you can you can also move the monitoring jobs of the Collector to the new group.

SecurityuserAuth

Request

path Parameters

required

string <uuid>

Unique identifier assigned to a Collector.

Request Body schema: application/json

groupId required	string or null Unique identifier of the group where the Collector will be moved.
moveJobs required	boolean Defines whether the Collector monitoring jobs will be also moved to the group.

Responses

204

No Content

401

Unauthorized

500

Internal Server Error

post/api/v1/collectors/collector/{id}/move

Request samples

application/json

{"groupId": "New Group",
"moveJobs": true
}

Response samples

application/json

{"message": "string"
}

Move Monitoring Jobs to Collector

The HTTP POST request to the /collectors/job/move endpoint moves a monitoring job to a target Collector. All monitoring jobs of the source Collector can be moved in a single request.

SecurityuserAuth

Request

Request Body schema: application/json

collectorId required	string <uuid> Unique identifier of the Collector where the job will be moved.
jobName required	string or null Name of the job that will be moved.
moveAllJobs required	boolean Defines whether to move all jobs from the source collector.

Responses

204

No Content

401

Unauthorized

500

Internal Server Error

post/api/v1/collectors/job/move

Request samples

application/json

{"jobName": "vcenter.lab.local/Cluster-01",
"collectorId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"moveAllJobs": false
}

Response samples

application/json

{"message": "string"
}

Unregister Collector

The HTTP POST request to the /collectors/collector/{id}/unregister endpoint unregisters a Collector and releases all objects monitored by this Collector.

SecurityuserAuth

Request

path Parameters

required

string <uuid>

Unique identifier assigned to a Collector.

Responses

204

No Content

401

Unauthorized

500

Internal Server Error

post/api/v1/collectors/collector/{id}/unregister

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"message": "string"
}

Trigger Topology Rebuild

The HTTP POST request to the /collectors/collector/{id}/rebuildTopology endpoint triggers a full topology rebuild for a Collector with the specified ID.

SecurityuserAuth

Request

path Parameters

required

string <uuid>

Unique identifier assigned to a Collector.

Responses

204

No Content

401

Unauthorized

500

Internal Server Error

post/api/v1/collectors/collector/{id}/rebuildTopology

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"message": "string"
}

Rebalance Monitoring Load Across All Groups

The HTTP POST request to the /collectors/rebalance endpoint rebalances monitoring load across all Collectors and groups.

SecurityuserAuth

Responses

204

No Content

401

Unauthorized

500

Internal Server Error

post/api/v1/collectors/rebalance

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"message": "string"
}

Rebalance Monitoring Load in Group

The HTTP POST request to the /collectors/group/{name}/rebalance endpoint rebalances monitoring load across the Collectors of a group with the specified name.

SecurityuserAuth

Request

path Parameters

name

required

string

Name assigned to a collector group.

Responses

204

No Content

401

Unauthorized

500

Internal Server Error

post/api/v1/collectors/group/{name}/rebalance

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"message": "string"
}

Create Collector Group

The HTTP POST request to the /collectors/group/add endpoint creates a new Collector group.

SecurityuserAuth

Request

Request Body schema: application/json

name

required

string or null

Name of the group.

Responses

204

No Content

401

Unauthorized

500

Internal Server Error

post/api/v1/collectors/group/add

Request samples

application/json

{"name": "New Group"
}

Response samples

application/json

{"message": "string"
}

Rename Collector Group

The HTTP POST request to the /collectors/group/{name}/rename endpoint changes the name of the specified Collector group.

SecurityuserAuth

Request

path Parameters

name

required

string

Name assigned to a collector group.

Request Body schema: application/json

name

required

string or null

Name of the group.

Responses

204

No Content

401

Unauthorized

500

Internal Server Error

post/api/v1/collectors/group/{name}/rename

Request samples

application/json

{"name": "New Group"
}

Response samples

application/json

{"message": "string"
}

Delete Collector Group

The HTTP POST request to the `/collectors/group/{name}/delete endpoint deletes a Collector group and moves the Collectors of this group to the default group.

SecurityuserAuth

Request

path Parameters

name

required

string

Name assigned to a collector group.

Responses

204

No Content

401

Unauthorized

500

Internal Server Error

delete/api/v1/collectors/group/{name}/delete

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"message": "string"
}