Search Schedule API
This API is used to fetch the details of all the schedules that are within the provided start and end dates.
Input ParametersInput Parameters
Parameter | Mandatory/ Optional | Data Type | Description |
---|---|---|---|
startAt | Optional | String | Provide the start date and time for filtering schedules. |
endAt | Optional | String | Provide the end date and time for filtering schedules. |
pageSize | Optional | Number | Provide the number of records you want to fetch per page. |
pageNumber | Optional | Number | Provide the page number of the specific page you want to fetch. You can use this parameter together with pageSize to paginate a large number of records. |
filter | Optional | String | Provide a filter to narrow down the search results. |
sort | Optional | String | Provide the sorting order for the results. For example, [{"created.dateTime":"desc"}] sorts the results by creation date and time in descending order. |
API Request
curl -X POST
'<qualys_base_url>/sm/v1/scheduler/search'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer {{authToken}}'
-d '{
"startAt": "2025-05-26T11:47:56.810Z",
"endAt": "2025-06-25T18:29:59.999Z",
"pageSize": 50,
"pageNumber": 0,
"filter": "",
"sort": "[{\"created.dateTime\":\"desc\"}]"
}
API Response
{ "body": { "totalCount": 3, "list": [ { "id": "ff7c906f-394d-4e9...", "customerUuid": "74c1bcdd-9bbb...", "title": "Sample title", "description": "Sample description", "status": "ACTIVE", "startTime": "16:20:00", "startDate": "2025-06-11", "endDate": null, "scheduleType": "ONE_TIME", "monthlyScheduleType": null, "hourlyInterval": null, "daysOfWeek": null, "recurrenceDate": null, "recurrenceDay": null, "recurrenceMonth": null, "recurrenceWeekDay": null, "created": { "dateTime": 1749478026579, "user": { "id": "ddf20f3a-cfd3-6fd...", "name": "User name" } }, "updated": { "dateTime": 1750851386130, "user": { "id": "ddf20f3a-cfd3-6fd4...", "name": "User name", "userName": "sample_username" } }, "lastExecutionDateTime": 0, "nextExecutionDateTime": 0, "assets": null, "excludedAssets": null, "assetTags": [ { "id": 1701, "UUId": "f1adce83-5cbe...." }, { "id": 3085, "UUId": "3695da6c-7130-4a..." } ], "scripts": [ { "id": 228, "title": "Sample Title", "platform": "WINDOWS", "language": { "id": 201, "name": "PowerShell-Command" }, "params": [] } ], "cronExpression": "00 20 16 11 06 ? 2025", "executionPolicyBypassEnabled": true, "allTagsForAssetsEnabled": false, "rebootAfterScriptExecution": false, "rebootDelayInSeconds": 0, "rebootDelayTimeUnit": null, "shareScriptResultWithFim": false }, { "id": "1228b42a-c8cc....", "customerUuid": "74xxxxxx-9xxx-e9....", "title": "Sample Title", "description": "Sample description", "status": "ACTIVE", "startTime": "09:52:00", "startDate": "2025-06-09", "endDate": null, "scheduleType": "ONE_TIME", "monthlyScheduleType": null, "hourlyInterval": null, "daysOfWeek": null, "recurrenceDate": null, "recurrenceDay": null, "recurrenceMonth": null, "recurrenceWeekDay": null, "created": { "dateTime": 1749461837962, "user": { "id": "ddf20f3a-cfd3-6fd...", "name": "User name" } }, "updated": { "dateTime": 1749461837962, "user": { "id": "ddf20f3a-cfd3-6f...", "name": "User name" } }, "lastExecutionDateTime": 1749462720649, "nextExecutionDateTime": 0, "assets": [ { "id": 44496319, "tags": null, "UUId": "2dabc804-fcea-4e..." }, { "id": 49526617, "tags": null, "UUId": "7bb9c14f-ccd0-49d..." } ], "excludedAssets": null, "assetTags": null, "scripts": [ { "id": 235820, "title": "Control ID Remediation", "platform": "WINDOWS", "language": { "id": 4, "name": "PowerShell-Script" }, "params": [] } ], "cronExpression": "00 52 09 09 06 ? 2025", "executionPolicyBypassEnabled": true, "allTagsForAssetsEnabled": false, "rebootAfterScriptExecution": false, "rebootDelayInSeconds": 0, "rebootDelayTimeUnit": null, "shareScriptResultWithFim": false }, { "id": "d2db575b-9d32-4d8f....", "customerUuid": "74c1bcdd-9bb....", "title": "Sample title", "description": "Sample description", "status": "INACTIVE", "startTime": "06:05:00", "startDate": "2025-05-27", "endDate": null, "scheduleType": "ONE_TIME", "monthlyScheduleType": null, "hourlyInterval": null, "daysOfWeek": null, "recurrenceDate": null, "recurrenceDay": null, "recurrenceMonth": null, "recurrenceWeekDay": null, "created": { "dateTime": 1748324967997, "user": { "id": "ddf20f3a-cfd3-6fd....", "name": "User name" } }, "updated": { "dateTime": 1748518315558, "user": { "id": "ddf20f3a-cfd3-6....", "name": "Name", "userName": "User name" } }, "lastExecutionDateTime": 1748424711837, "nextExecutionDateTime": 0, "assets": [ { "id": 4449, "tags": null, "UUId": "2dabc804-fce...." }, { "id": 4952, "tags": null, "UUId": "7bb9c14f-ccd...." } ], "excludedAssets": null, "assetTags": null, "scripts": [ { "id": 235, "title": "Sample title", "platform": "WINDOWS", "language": { "id": 4, "name": "PowerShell-Script" }, "params": [] } ], "cronExpression": "00 05 06 27 05 ? 2025", "executionPolicyBypassEnabled": true, "allTagsForAssetsEnabled": false, "rebootAfterScriptExecution": false, "rebootDelayInSeconds": 0, "rebootDelayTimeUnit": null, "shareScriptResultWithFim": true } ] } }