Schedule-based API
Use the following API functions to perform operations on schedules:
Count Number of Schedules
This API lets you fetch the count of schedules that have been created.
Input ParametersInput Parameters
Parameter | Mandatory/Optional | Data Type | Description |
---|---|---|---|
filter | Optional | String | Filter requests by providing a query using Qualys syntax. Refer to the How to Search topic in the online help for assistance.
Some examples are:
|
startAt/endAt | Optional | String | Search for schedules by specifying the start date/end date. |
groupBy | Optional | String | Group schedules by specifying parameters such as scheduler status, agent version, and so on. |
API Request
"curl --location --request POST""https://qualys_base_url/sm/v1/scheduler/count""\\
--header""Authorization: <Bearer Token> \\
--header ""Content-Type":"application/json"" \\
--data-raw "{
" ""startAt":"2022-11-01T00:00:01.000Z",
" ""endAt":"2023-01-11T23:59:59.999Z"
}"'"
Request Body
{
"startAt": "2022-11-01T00:00:01.000Z",
"endAt": "2023-01-11T23:59:59.999Z"
}
Response
{
"body": {
"count": 17
}
}
API Request
"curl --location --request POST""https://qualys_base_url/sm/v1/scheduler/count""\\
--header""Authorization: <Bearer Token> \\
--header ""Content-Type":"application/json"" \\
--data-raw "{
"groupBy":[
"status"
]
}"'"
Request Body
{ "groupBy":["status"] }
Response
{
"body": {
"ACTIVE": 133,
"INACTIVE": 60
}
}