Get Schedule API

This API is used to fetch the script schedule using the schedule ID.

GET /sm/v1/scheduler/{id}

Parameter	Mandatory/ Optional	Data Type	Description
id	Mandatory	String	Provide the schedule ID in the URL.

Sample: Fetch details of a script scheduleSample: Fetch details of a script schedule

API Request

curl -X GET
'<qualys_base_url>/sm/v1/scheduler/123'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer {{authToken}}'

API Response

{
    "body": {
        "id": "ff7c906f-394d-4e9b....",
        "customerUuid": "74c1bcdd-9bbb-e9....",
        "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-6fd4...",
                "name": "User name"
            }
        },
        "updated": {
            "dateTime": 1750851386130,
            "user": {
                "id": "ddf20f3a-cfd3-6fd4...",
                "name": "Patrick",
                "userName": "username"
            }
        },
        "lastExecutionDateTime": 0,
        "nextExecutionDateTime": 0,
        "assets": null,
        "excludedAssets": null,
        "assetTags": [
            
            {
                "id": 47668263,
                "UUId": "6130ed10-e64f-40a6..."
            },
            {
                "id": 28902062,
                "UUId": "3dff19c9-e7cc-4e4..."
            },
            {
                "id": 31486542,
                "UUId": "d0a3ff1f-d7d8-4ef..."
            }
        ],
        "scripts": [
            {
                "id": 228837,
                "title": "Sample Script",
                "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
    }
}