List Report Schedules

Retrieves a list of report schedules with their corresponding details from your account. You can also use this API to fetch details of a specific schedule by specifying its UUID.

GETcsapi/v1.3/reports/schedules

Input ParametersInput Parameters

Parameter	Mandatory/Optional	Data Type	Description
pageNumber	Optional	integer	Specify the page to be returned.
reportScheduleUuid	Optional	string	If you want to fetch details of a particular schedule, specify the UUID of the schedule.
pageSize	Optional	integer	Specify the number of records to display per page.
sort	Optional	string	Specify how to sort the records in the response. The supported values are: createdDate and name.

Sample 1: List All Report Schedules from Your AccountSample 1: List All Report Schedules from Your Account

API Request

curl -X GET
"<qualys_base_url>/csapi/v1.3/reports/schedules?pageNumber=1&pageSize=50&sort=createdDate%20%3Adesc"
-H "accept: application/*"
-H "Authorization: Bearer <token>"

Response

{
  "data": [
    {
      "name": "CRS-TEST-3",
      "reportScheduleUuid": "bc9cf320-c317-11ed-8d67-39e6329594da",
      "scheduledDatetime": "2023-03-15T09:57:27.000Z",
      "templateName": "CS_IMAGE_VULNERABILITY",
      "resourceId": "bf21812e-92f7-4bcc-be4a-3d2f02642c9c",
      "action": "CREATE",
      "eventTime": "2023-03-15T09:58:00Z",
      "eventEndTime": "2023-03-22T16:25:00Z",
      "cronExpression": "0 58 9 1/1 * ? *",
      "description": "",
      "createdDateTime": "2023-03-15T09:57:27.000Z",
      "nextFireTime": "2023-03-16T09:58:00.000Z",
      "state": "RESUME",
      "format": "csv",
      "moduleCode": "CS",
      "displayColumns": [
        "repo",
        "uuid",
        "sha",
        "severity",
        "firstDetected",
        "qid",
        "imageId"
      ],
      "emailNotification": 1,
      "filter": "",
      "reportScheduleDetails": {
        "recurrenceType": "DAILY",
        "selectedDayOfWeeks": null,
        "monthlyType": null,
        "ordinalDayOfMonth": 0,
        "dayOfWeek": null,
        "ordinalDayOfWeek": 0
      },
      "expireAfter": 30,
      "recipient": "john_doe@gmail.com",
      "customMessage": "Check the report generated.",
      "sendAsAttachment": 1,
      "emailSubject": "Qualys-test report",
      "zip": 1
    },
    {
      "name": "CRS-TIME-TEST-2",
      "reportScheduleUuid": "b44ebfb0-c316-11ed-8d67-39e6329594da",
      "scheduledDatetime": "2023-03-15T09:50:03.000Z",
      "templateName": "CS_IMAGE_VULNERABILITY",
      "resourceId": "1ffa0872-b92d-40ca-8ab8-593e52ecbd46",
      "action": "CREATE",
      "eventTime": "2023-03-15T09:51:00Z",
      "eventEndTime": "2023-03-16T16:16:00Z",
      "cronExpression": "0 51 9 1/1 * ? *",
      "description": "",
      "createdDateTime": "2023-03-15T09:50:03.000Z",
      "nextFireTime": "2023-03-16T09:51:00.000Z",
      "state": "RESUME",
      "format": "csv",
      "moduleCode": "CS",
      "displayColumns": [
        "repo",
        "uuid",
        "sha",
        "severity",
        "firstDetected",
        "qid",
        "imageId"
      ],
      "emailNotification": 1,
      "filter": "",
      "reportScheduleDetails": {
        "recurrenceType": "DAILY",
        "selectedDayOfWeeks": null,
        "monthlyType": null,
        "ordinalDayOfMonth": 0,
        "dayOfWeek": null,
        "ordinalDayOfWeek": 0
      },
      "expireAfter": 30,
      "recipient": "john_doe@gmail.com",
      "customMessage": "Check the report generated.",
      "sendAsAttachment": 1,
      "emailSubject": "Qualys-test report",
      "zip": 1
    },
    },
    {
      "name": "CRS-TIME-TEST",
      "reportScheduleUuid": "4adc45c0-c316-11ed-8d67-39e6329594da",
      "scheduledDatetime": "2023-03-15T09:47:06.000Z",
      "templateName": "CS_IMAGE_VULNERABILITY",
      "resourceId": "efc13ea6-81ad-4cd5-a1d2-e8031f0401c6",
      "action": "CREATE",
      "eventTime": "2023-03-15T15:16:00Z",
      "eventEndTime": "2023-03-16T16:16:00Z",
      "cronExpression": "0 16 15 1/1 * ? *",
      "description": "",
      "createdDateTime": "2023-03-15T09:47:06.000Z",
      "nextFireTime": "2023-03-16T15:16:00.000Z",
      "state": "RESUME",
      "format": "csv",
      "moduleCode": "CS",
      "displayColumns": [
        "repo",
        "uuid",
        "sha",
        "severity",
        "firstDetected",
        "qid",
        "imageId"   ],
      "emailNotification": 1,
      "filter": "",
      "reportScheduleDetails": {
        "recurrenceType": "DAILY",
        "selectedDayOfWeeks": null,
        "monthlyType": null,
        "ordinalDayOfMonth": 0,
        "dayOfWeek": null,
        "ordinalDayOfWeek": 0
      },
      "expireAfter": 30,
      "recipient": "john_doe@gmail.com",
      "customMessage": "Check the report generated.",
      "sendAsAttachment": 1,
      "emailSubject": "Qualys-test report",
      "zip": 1
      },
  ...
  ],
  "count": 150,
  "groups": null
}

Sample 2: Fetch Details of a Specific Report ScheduleSample 2: Fetch Details of a Specific Report Schedule

API Request

curl -X GET
"<qualys_base_url>/csapi/v1.3/reports/schedules?pageNumber=1&reportScheduleUuid=e82571d0-c2e9-11ed-bf38-5563a478dc98&pageSize=50&sort=createdDate%20%3Adesc"
-H "accept: application/*"
-H "Authorization: Bearer <token>"

Response

{
  "data": [
    {
      "name": "CRS-DEMO-DAILY",
      "reportScheduleUuid": "e82571d0-c2e9-11ed-bf38-5563a478dc98",
      "scheduledDatetime": "2023-03-15T04:29:22.000Z",
      "templateName": "CS_IMAGE_VULNERABILITY",
      "resourceId": "487a42bf-fa52-4dab-ac06-aa85598a4873",
      "action": "CREATE",
      "eventTime": "2023-03-14T07:23:54.000Z",
      "eventEndTime": "2023-03-15T07:23:54.000Z",
      "cronExpression": "0 23 7 1/1 * ? *",
      "description": "",
      "createdDateTime": "2023-03-15T04:29:22.000Z",
      "nextFireTime": null,
      "state": "COMPLETED",
      "format": "csv",
      "moduleCode": "CS",
      "displayColumns": [
        "repo",
        "uuid",
        "sha",
        "severity",
        "firstDetected",
        "qid",
        "imageId"
      ],
      "emailNotification": 1,
      "filter": "",
      "reportScheduleDetails": {
        "recurrenceType": "DAILY",
        "selectedDayOfWeeks": null,
        "monthlyType": null,
        "ordinalDayOfMonth": 0,
        "dayOfWeek": null,
        "ordinalDayOfWeek": 0
      },
      "expireAfter": 30,
      "recipient": "john_doe@gmail.com",
      "customMessage": "Check the report generated.",
      "sendAsAttachment": 1,
      "emailSubject": "Qualys-test report",
      "zip": 1
    },
  ],
  "count": 1,
  "groups": null
}