Create a recurring inventory scan schedule

Creates a recurring inventory scan schedule for managed devices.

Schedule Types:
• Daily: Run scans every day, on alternate days, or on weekdays only
• Weekly: Run scans on specific days of the week
• Monthly: Run scans on specific months and days

Note: Required fields vary based on the selected scheduleType. Refer to the request examples for each schedule type.

Endpoints

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

Copy full URL

Request URL

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

Scope

DesktopCentralCloud.BrowserManager.CREATECopied!

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 POST \
  --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("POST", 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("POST", "/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: POST
        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 POST -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body - Daily Schedule

Daily schedule

Copied!

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

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --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("POST", 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("POST", "/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: POST
        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 POST -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body - Weekly Schedule

Weekly schedule

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 POST \
  --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("POST", 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("POST", "/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: POST
        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 POST -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body - Monthly Schedule

Monthly schedule

Copied!

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

▼ Show full

Response Parameters

- HTTP code 204

Response Body - application/json

JSON Object

Hide 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

204HTTP code

Returns 204 No Content on success.

400HTTP code

401HTTP code

403HTTP code

429HTTP code

500HTTP code

Sample Response: HTTP 204

Copied!

204 Returns 204 No Content on success.

▼ 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.