Update Schedule API

This API is used to update an existing schedule.

POST/sm/v1/scheduler/{id}

Parameter		Mandatory/ Optional	Data Type	Description
activate		Optional	Boolean	Provide `true` to activate the schedule or `false` to keep it inactive.
assetTags		Optional	List	Provide a list of specific asset tag IDs and UUIDs to include in the schedule.
assets		Optional	List	Provide a list of specific asset IDs and UUIDs to include in the schedule.
description		Optional	String	Provide a description of the schedule.
excludedAssets		Optional	List	Specify a list of assets to exclude from the scheduled script execution.
scripts		Mandatory	List	Include details of the scripts to execute with the schedule.
	id	Mandatory	Long	Provide the ID of the script to be scheduled for execution.
	title	Mandatory	String	Provide the title of the script to be executed.
	params	Optional	List	Provide the list of script parameters. It is mandatory in the case of a parameterized script.
title		Mandatory	String	Provide a title for the schedule.
user		Optional	List	Provide details of the user who is scheduling the script.
allTagsForAssets Enabled		Optional	Boolean	Provide `true` if all tags for that asset are enabled; otherwise, `false`.
rebootAfter ScriptExecution		Optional	Boolean	Provide `true` or `false` to reboot the asset after the script execution.
rebootDelayIn Seconds		Optional	Number	Specify the time in seconds after which the asset should reboot.
rebootDelayTimeUnit		Optional	String	Specify the time unit for the reboot delay. Accepted values: hours minutes seconds
startDate		Mandatory	Integer	Provide the start date for the schedule.
startTime		Mandatory	Integer	Provide the start time for the schedule.
scheduleType		Mandatory	String	Provide the schedule type. Accepted values: ONE_TIME RECURRING
executionPolicy BypassEnabled		Optional	Boolean	Provide `true` to bypass the PowerShell execution policy on Windows hosts and run scripts regardless of the policy. If `false`, CAR follows the host’s execution policy. This parameter is applicable only for Windows PowerShell script execution.
shareScript ResultWithFim		Optional	Boolean	Provide `true` or `false` to share the script output with File Integrity Monitoring (FIM).

Sample: Update a scheduleSample: Update a schedule

API Request

curl -X POST
'<qualys_base_url>/sm/v1/scheduler/124'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer {{authToken}}'
-d '{
  "activate": true,
  "assetTags": [
    { "UUId": "7bb9c14f-ccd0-49d6...",
      "id": 49526479
    }
],
  "assets": [
    {
      "UUId": "7bb9c14f-ccd0-49d6...",
      "id": 49526617
    }
  ],
  "description": "Sample_description",
  "excludedAssets": [],
  "scripts": [
    {
      "id": 236773,
      "title": "Sample title",
      "params": [
        {
          "key": "xXXxXXXx",
          "value": "SGV5IEhpaSAhISBT....",
          "mandatory": false
        }
      ]
    }
  ],
  "title": "Sample title",
  "user": {
    "id": "ddf20f3a-cfd3-6fd4...",
    "name": "John"
  },
  "allTagsForAssetsEnabled": false,
  "rebootAfterScriptExecution": false,
  "rebootDelayInSeconds": null,
  "rebootDelayTimeUnit": null,
  "startDate": "2025-06-25",
  "startTime": "13:37:00",
  "scheduleType": "ONE_TIME",
  "executionPolicyBypassEnabled": true,
  "shareScriptResultWithFim": false
}'

API Response

{
    "errorCode": "0",
    "message": "Scheduler updated successfully",
    "body": "c62f7279-3d05-4cf..."
}