Update the scan schedule

Updates the schedule used to scan managed devices.

Endpoints

put /bsp/api/v1/bmp/devices/scan/schedule

Copy full URL

Request URL

https://{serverurl}/bsp/api/v1/bmp/devices/scan/schedule

Scope

DesktopCentralCloud.BrowserManager.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/jsonCopied!

Content-TypestringMandatory

application/jsonCopied!

- Request Body

application/json

JSON Object

Hide Sub-Attributes

Schedule ConfigOptional

Show Sub-Attributes

oneOf

Examples

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomains/bsp/api/v1/bmp/devices/scan/schedule \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/bsp/api/v1/bmp/devices/scan/schedule"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

payload = "{}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/bsp/api/v1/bmp/devices/scan/schedule", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/json");
    headersMap.put("Content-Type", "application/json");

    data=Map();

    response = invokeUrl
    [
        url: "https://appDomains/bsp/api/v1/bmp/devices/scan/schedule"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/bsp/api/v1/bmp/devices/scan/schedule' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body - Daily Schedule

Disable scheduler

Copied!

  {
    "dailyTime": "04/14/2026, 08:47",
    "taskTimeZone": "Asia/Calcutta",
    "scheduleType": "Daily",
    "schedulerDisabled": true,
    "dailyIntervalType": "alternativeDays"
  }

▼ Show full

Modify to daily

Copied!

  {
    "dailyTime": "04/15/2026, 09:30",
    "taskTimeZone": "Asia/Calcutta",
    "scheduleType": "Daily",
    "schedulerDisabled": false,
    "dailyIntervalType": "alternativeDays"
  }

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomains/bsp/api/v1/bmp/devices/scan/schedule \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/bsp/api/v1/bmp/devices/scan/schedule"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

payload = "{}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/bsp/api/v1/bmp/devices/scan/schedule", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/json");
    headersMap.put("Content-Type", "application/json");

    data=Map();

    response = invokeUrl
    [
        url: "https://appDomains/bsp/api/v1/bmp/devices/scan/schedule"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/bsp/api/v1/bmp/devices/scan/schedule' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body - Weekly Schedule

Modify to weekly

Copied!

  {
    "taskTimeZone": "Asia/Calcutta",
    "scheduleType": "Weekly",
    "daysOfWeek": "4",
    "schedulerDisabled": false,
    "weeklyTime": "21:39"
  }

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomains/bsp/api/v1/bmp/devices/scan/schedule \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/bsp/api/v1/bmp/devices/scan/schedule"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

payload = "{}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/bsp/api/v1/bmp/devices/scan/schedule", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/json");
    headersMap.put("Content-Type", "application/json");

    data=Map();

    response = invokeUrl
    [
        url: "https://appDomains/bsp/api/v1/bmp/devices/scan/schedule"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/bsp/api/v1/bmp/devices/scan/schedule' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body - Monthly Schedule

Modify to monthly

Copied!

  {
    "taskTimeZone": "Asia/Calcutta",
    "scheduleType": "Monthly",
    "monthlyWeekNum": "1",
    "monthlyTime": "09:00",
    "monthsList": "1,3,8,9",
    "monthlyWeekDay": "6",
    "schedulerDisabled": false,
    "monthlyPerform": "WeekDay"
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Scan schedule configuration. Returned by both GET and PUT /devices/scan/schedule. Field set varies by scheduletype: Daily includes dailytime + dailyintervaltype; Weekly includes weeklytime + daysofweek; Monthly includes monthlytime + monthslist + monthlyperform + monthlyweeknum + monthlyweekday

Hide Sub-Attributes

schedulerdisabledboolean

true=schedule is currently disabled (no scans will run automatically); false=schedule is active

scheduletypestring

Current schedule frequency. One of: 'Daily', 'Weekly', 'Monthly'

scheduletypeextratextstring

Human-readable summary of the schedule. Daily: interval label (e.g. 'alternativeDays'). Weekly: weekday short name (e.g. 'Wed'). Monthly: comma-separated month short names (e.g. 'Feb, Apr, Sep, Oct')

tasktimezonestring

IANA timezone ID for which the schedule times are evaluated (e.g. 'Asia/Calcutta')

currentdatetimestring

Current server date-time (RFC 1123 format)

nextruntimestring

Next scheduled scan execution time (RFC 1123 format)

starttimetextstring

Formatted start-time label shown in UI

starttimeextratextstring

Additional context for start time (Monthly schedules only, e.g. 'during First Friday of selected Months')

dailytimestring

[Daily only] Configured start date-time for daily schedule (e.g. '04/15/2026, 09:30')

dailyintervaltypestring

[Daily only] Daily interval mode. One of: 'everyDay', 'alternativeDays', 'weekDays'

weeklytimestring

[Weekly only] Configured time-of-day for weekly schedule (HH:mm, 24h)

daysofweekstring

[Weekly only] Comma-separated day-of-week numbers (1=Sun, 2=Mon, 3=Tue, 4=Wed, 5=Thu, 6=Fri, 7=Sat)

monthlytimestring

[Monthly only] Configured time-of-day for monthly schedule (HH:mm, 24h)

monthsliststring

[Monthly only] Comma-separated month numbers (1=Jan … 12=Dec)

monthlyperformstring

[Monthly only] How the day is selected within each month. One of: 'Day' (specific date), 'WeekDay' (Nth weekday)

monthlyweeknumstring

[Monthly only, when monthlyperform=WeekDay] Which week of the month (1=First … 4=Fourth, 5=Last)

monthlyweekdaystring

[Monthly only, when monthlyperform=WeekDay] Day-of-week (1=Sun … 7=Sat)

last_schedule_detailsJSON Object

Summary of the last executed scan: scan_initiated, in_progress, success, failed device counts

Show Sub-Attributes

- HTTP code 400

Response Body - application/json

JSON Object

Bad request error when an invalid or unsupported parameter is detected in the scan schedule request

Hide Sub-Attributes

errorCodestring

Error code indicating an invalid parameter was detected in the request

errorMsgstring

Message identifying the invalid parameter that was detected

urlstring

Request URL that triggered the error

- HTTP code 401

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 403

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Error code indicating insufficient permissions

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Rate limit error code returned when the API call reached threshold

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json

JSON Object

Internal server error during device operations

Hide Sub-Attributes

error_descriptionstring

Message describing the server-side failure

error_codestring

Internal server error code

Possible Response Codes

200HTTP code

400HTTP code

401HTTP code

403HTTP code

429HTTP code

500HTTP code

Sample Response: HTTP 200

Weekly config

Copied!

  {
    "tasktimezone": "Asia/Calcutta",
    "last_schedule_details": {
      "scan_initiated": "0",
      "in_progress": "1",
      "success": "0",
      "failed": "0"
    },
    "weeklytime": "21:39",
    "scheduletype": "Weekly",
    "currentdatetime": "Wed, 08 Apr 2026 08:45:09 AM",
    "daysofweek": "4",
    "scheduletypeextratext": "Wed",
    "schedulerdisabled": false,
    "nextruntime": "Wed, 08 Apr 2026 09:39:00 PM",
    "starttimetext": "21:39",
    "starttimeextratext": ""
  }

▼ Show full

Daily config

Copied!

  {
    "dailytime": "04/15/2026, 09:30",
    "tasktimezone": "Asia/Calcutta",
    "last_schedule_details": {
      "scan_initiated": "0",
      "in_progress": "1",
      "success": "0",
      "failed": "0"
    },
    "scheduletype": "Daily",
    "dailyintervaltype": "alternativeDays",
    "currentdatetime": "Wed, 08 Apr 2026 08:51:26 AM",
    "scheduletypeextratext": "alternativeDays",
    "schedulerdisabled": false,
    "nextruntime": "Wed, 15 Apr 2026 09:30:00 AM",
    "starttimetext": "Wed, 15 Apr 2026 09:30:00 AM",
    "starttimeextratext": ""
  }

▼ Show full

Monthly config

Copied!

  {
    "tasktimezone": "Asia/Calcutta",
    "last_schedule_details": {
      "scan_initiated": "0",
      "in_progress": "1",
      "success": "0",
      "failed": "0"
    },
    "monthlytime": "09:00",
    "scheduletype": "Monthly",
    "monthlyweekday": "6",
    "nextruntime": "Fri, 04 Sep 2026 09:00:00 AM",
    "starttimetext": "09:00",
    "starttimeextratext": "during First Friday of selected Months",
    "currentdatetime": "Wed, 08 Apr 2026 09:10:49 AM",
    "monthslist": "1,3,8,9",
    "monthlyperform": "WeekDay",
    "scheduletypeextratext": "Feb, Apr, Sep, Oct",
    "schedulerdisabled": false,
    "monthlyweeknum": "1"
  }

▼ Show full

Sample Response: HTTP 400

Invalid parameter

Copied!

  {
    "errorCode": "IAM0018",
    "url": "/bsp/api/v1/bmp/devices/scan/schedule",
    "errorMsg": "Invalid parameter \"param\" detected."
  }

▼ Show full

Sample Response: HTTP 401

Unauthorized

Copied!

  {
    "errorCode": "UNAUTHORIZED",
    "errorMsg": "You are not authorized to perform this action"
  }

▼ Show full

Sample Response: HTTP 403

Forbidden

Copied!

  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "You do not have permission to access this resource"
  }

▼ Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!

  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
  }

▼ Show full

Sample Response: HTTP 500

Server error

Copied!

  {
    "error_description": "Internal Server error, Please try again in a moment.",
    "error_code": "COM0004"
  }

▼ Show full

Duration: 1 minute | Threshold: 60 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.