Task Sessions

This resource collection represents tasks and task sessions.

Get All Task Sessions

Returns a collection resource representation of all task sessions.

SecurityBearer

Request

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Responses

200

Success

400

Bad Request

403

Forbidden

get/api/v2.3/sessions

Request samples

curl

Response samples

application/json

{"items": [{"jobSessionId": 1466,
"name": "Object properties data collection",
"type": "AggregateProperties",
"status": "Processing",
"statusPriority": 6,
"start": "2025-07-10T09:55:38.64Z",
"end": null
},
{"jobSessionId": 1000,
"name": "Object properties data collection",
"type": "AggregateProperties",
"status": "Success",
"statusPriority": 0,
"start": "2025-07-10T04:41:07.303Z",
"end": "2025-07-10T04:41:07.303Z"
},
{"jobSessionId": 1001,
"name": "Business View categories refresh",
"type": "BusinessviewData",
"status": "Success",
"statusPriority": 0,
"start": "2025-07-10T04:41:08.14Z",
"end": "2025-07-10T04:41:15.61Z"
},
{"jobSessionId": 1002,
"name": "Business View categories refresh",
"type": "BusinessviewData",
"status": "Success",
"statusPriority": 0,
"start": "2025-07-10T04:45:35.927Z",
"end": "2025-07-10T04:45:40.847Z"
}
],
"totalCount": 4
}

Get Task Session

Returns a resource representation of a task session with the specified ID.

SecurityBearer

Request

path Parameters

sessionId

required

integer <int32>

Job session ID

Responses

200

Success

204

No Content

400

Bad Request

403

Forbidden

get/api/v2.3/sessions/{sessionId}

Request samples

curl

Response samples

application/json

{"jobSessionId": 1466,
"name": "Object properties data collection",
"type": "AggregateProperties",
"status": "Processing",
"statusPriority": 6,
"start": "2025-07-10T09:55:38.64Z",
"end": null
}

Get Task Session Details

Returns a collection resource representation of operations performed during a task session with the specified ID.

SecurityBearer

Request

path Parameters

sessionId

required

integer <int32>

Job session ID.

Responses

200

Success

400

Bad Request

403

Forbidden

get/api/v2.3/sessions/{sessionId}/details

Request samples

curl

Response samples

application/json

[{"sessionRecordId": 0,
"details": "Veeam ONE is installed successfully. Root objects are collected.",
"logDateTime": "'2021-01-27T11:54:31.84Z'"
}
]

Get Data Collection Status

Returns a resource representation of data collection status.

SecurityBearer

Responses

200

Success

403

Forbidden

get/api/v2.3/dataCollection/status

Request samples

curl

Response samples

application/json

{"progress": 84,
"status": "Processing",
"manuallyStart": false,
"nextRun": "2025-07-06T15:07:44.823Z",
"tasksSuccess": 5,
"tasksWarning": 0,
"tasksFailed": 0,
"tasksStopped": 0
}

Get All Data Collection Tasks

Returns a collection resource representation of data collection tasks.

SecurityBearer

Request

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Responses

200

Success

400

Bad Request

403

Forbidden

get/api/v2.3/dataCollection/tasks

Request samples

curl

Response samples

application/json

{"items": [{"sessionId": 1376,
"taskId": 4,
"name": "vc1.tech.local",
"status": "Processing",
"statusPriority": 6,
"modified": "2025-07-06T05:21:04.01Z",
"lastRun": "2025-07-06T14:41:49.433Z",
"collectingType": "VMwarevCenter"
},
{"sessionId": 1378,
"taskId": 5,
"name": "repVBR.tech.local",
"status": "Success",
"statusPriority": 0,
"modified": "2025-07-06T04:58:49.96Z",
"lastRun": "2025-07-06T14:41:50.05Z",
"collectingType": "VBR"
},
{"sessionId": 1375,
"taskId": 6,
"name": "chv2.tech.local",
"status": "Success",
"statusPriority": 0,
"modified": "2025-07-06T04:59:13.327Z",
"lastRun": "2025-07-06T14:41:49.15Z",
"collectingType": "VMwarevCenter"
},
{"sessionId": 1377,
"taskId": 7,
"name": "hvClusterWin19.tech.local",
"status": "Success",
"statusPriority": 0,
"modified": "2025-07-06T05:20:45.14Z",
"lastRun": "2025-07-06T14:41:49.703Z",
"collectingType": "HyperVFailoverCluster"
}
],
"totalCount": 4
}

Get Data Collection Schedule

Returns a resource representation of data collection schedule.

SecurityBearer

Responses

200

Success

403

Forbidden

get/api/v2.3/dataCollection/schedule

Request samples

curl

Response samples

application/json

{"startTime": "2025-07-09T02:00:00Z",
"timeZoneId": "",
"scheduleType": "Daily",
"disabled": false,
"periodically": {"period": 1,
"interval": "Hours"
},
"daily": {"daysOfWeek": ["Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
]
},
"monthlyDays": {"months": [ ],
"days": [ ]
},
"monthlyWeekDays": {"months": [ ],
"dayOfWeekAppearance": [ ],
"daysOfWeek": ["Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
]
}
}

Patch Data Collection Schedule

Modifies data collection schedule. Periodic scheduling type is configured in hourly intervals.

SecurityBearer

Request

Request Body schema: application/json

scheduleType required	string Type of a data collection schedule. Enum: "Manually" "Daily" "MonthlyDays" "MonthlyWeekDays" "Periodic"
startTime required	string <date-time> Time and date of the data collection session start.
timeZoneId	string or null ID assigned to a time zone.
disabled	boolean Indicates whether a data collection schedule is enabled.
	object or null Settings for periodic scheduling.
	object or null Settings for daily scheduling.
	object or null Scheduling settings for monthly data collection on specific date.
	object or null Scheduling settings for monthly data collection on specific week days.

Responses

200

Success

400

Bad Request

403

Forbidden

patch/api/v2.3/dataCollection/schedule

Request samples

Payload
curl

application/json

{"startTime": "2025-07-09T02:00:00Z",
"timeZoneId": "",
"scheduleType": "Daily",
"disabled": false,
"periodically": {"period": 1,
"interval": "Hours"
},
"daily": {"daysOfWeek": ["Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
]
},
"monthlyDays": {"months": [ ],
"days": [ ]
},
"monthlyWeekDays": {"months": [ ],
"dayOfWeekAppearance": [ ],
"daysOfWeek": ["Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
]
}
}

Response samples

application/json

{"startTime": "2025-07-09T02:00:00Z",
"timeZoneId": "",
"scheduleType": "Daily",
"disabled": false,
"periodically": {"period": 1,
"interval": "Hours"
},
"daily": {"daysOfWeek": ["Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
]
},
"monthlyDays": {"months": [ ],
"days": [ ]
},
"monthlyWeekDays": {"months": [ ],
"dayOfWeekAppearance": [ ],
"daysOfWeek": ["Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
]
}
}

Start Data Collection

Starts a data collection session.

SecurityBearer

Responses

200

Success

403

Forbidden

post/api/v2.3/dataCollection/start

Request samples

curl

Response samples

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Stop Data Collection

Stops data collection session.

SecurityBearer

Responses

200

Success

403

Forbidden

post/api/v2.3/dataCollection/stop

Request samples

curl

Response samples

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}