---
updatedAt: 2026-09-28T14:04:17.000Z
agentTools:
  projectIndex: https://developer.searchblox.com/llms.txt
---

# Update Scheduler - /rest/collection/updateScheduler

JSON  Payload

[block:parameters]
{
  "data": {
    "h-0": "XML Tag",
    "h-1": "Attribute",
    "h-2": "Value",
    "0-0": "apikey",
    "0-1": "",
    "0-2": "API key accessible in the SearchBlox Admin Console. It is also present in the config.xml file.",
    "1-0": "colname",
    "1-2": "Name of the Collection",
    "2-0": "index",
    "2-1": "frequency",
    "2-2": "Specifies the frequency of indexing of web documents. The values can be ONCE, DAILY, MINUTELY, WEEKLY and MONTHLY.",
    "3-0": "",
    "3-1": "timestamp",
    "3-2": "Specifies the timestamp when the indexing has to start. Eg: 21-01-2016 19:05:00.",
    "4-0": "clear",
    "6-0": "refresh",
    "4-1": "frequency",
    "6-1": "frequency",
    "5-1": "timestamp",
    "7-1": "timestamp",
    "4-2": "Specifies the frequency of clearing of indexed documents. The values can be ONCE, DAILY, MINUTELY, WEEKLY and MONTHLY.",
    "5-2": "Specifies the timestamp when the clearing has to occur. Eg: 21-01-2016 19:05:00.",
    "6-2": "Specifies the frequency of refreshing of web documents. The values can be ONCE, DAILY, MINUTELY, WEEKLY and MONTHLY.",
    "7-2": "Specifies the timestamp when the refreshing has to start. Eg: 21-01-2016 19:05:00."
  },
  "cols": 3,
  "rows": 8
}
[/block]

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "api-settings",
    "version": "12.2"
  },
  "servers": [
    {
      "url": "https://127.0.0.1:8443/"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/rest/collection/updateScheduler": {
      "post": {
        "summary": "Update Scheduler - /rest/collection/updateScheduler",
        "description": "JSON  Payload",
        "operationId": "json-restcollectionupdatescheduler",
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "description": "application/json",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Accept",
            "in": "header",
            "description": "application/json",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "SB-PKEY",
            "in": "header",
            "description": "Security Key by SBAdmin or Admin",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\"message\":\"Collection schedule saved successfully\",\"statusCode\":50008}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Collection schedule saved successfully"
                    },
                    "statusCode": {
                      "type": "integer",
                      "example": 50008,
                      "default": 0
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```