{
  "id": "job_scheduler",
  "title": "Job scheduler requests",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/job_scheduler/",
  "summary": "REST API requests for the job scheduler",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#get-job-scheduler) | `/v1/job_scheduler` | Get job scheduler settings |\n| [PUT](#put-job-scheduler) | `/v1/job_scheduler` | Update job scheduler settings |\n\n## Get job scheduler settings {#get-job-scheduler}\n\n```sh\nGET /v1/job_scheduler\n```\n\nGet job scheduler information.\n\n### Permissions\n\n| Permission name | Roles |\n|-----------------|-------|\n| [view_cluster_info]() | admin\u003cbr /\u003ecluster_member\u003cbr /\u003ecluster_viewer\u003cbr /\u003edb_member\u003cbr /\u003edb_viewer\u003cbr /\u003euser_manager |\n\n### Request {#get-request}\n\n#### Example HTTP request\n\n```sh\nGET /v1/job_scheduler\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n### Response {#get-response}\n\nReturns a [job_scheduler object]().\n\n#### Example JSON body\n\n```json\n{\n  \"backup_job_settings\": {\n    \"cron_expression\": \"*/5 * * * *\",\n    \"enabled\": true\n  },\n  \"bdb_usage_report_job_settings\": {\n    \"cron_expression\": \"0 */1 * * *\",\n    \"enabled\": false,\n    \"file_retention_days\": 365\n  },\n  \"cert_rotation_job_settings\": {\n    \"cron_expression\": \"0 * * * *\",\n    \"enabled\": true,\n    \"expiry_days_before_rotation\": 60\n  },\n  \"log_rotation_job_settings\": {\n    \"cron_expression\": \"*/5 * * * *\",\n    \"enabled\": true\n  },\n  \"node_checks_job_settings\": {\n    \"cron_expression\": \"0 * * * *\",\n    \"enabled\": true\n  },\n  \"redis_cleanup_job_settings\": {\n    \"cron_expression\": \"0 * * * *\"\n  },\n  \"rotate_ccs_job_settings\": {\n    \"cron_expression\": \"*/5 * * * *\",\n    \"enabled\": true,\n    \"file_suffix\": \"5min\",\n    \"rotate_max_num\": 24\n  }\n}\n```\n\n#### Status codes {#get-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | No error. |\n\n## Update job scheduler settings {#put-job-scheduler}\n\n```sh\nPUT /v1/job_scheduler\n```\n\nUpdate job scheduler settings.\n\n### Permissions\n\n| Permission name | Roles |\n|-----------------|-------|\n| [update_cluster]() | admin |\n\n### Request {#put-request}\n\n#### Example HTTP request\n\n```sh\nPUT /v1/job_scheduler\n```\n\n#### Example JSON body\n\n```json\n{\n   \"backup_job_settings\": {\n     \"cron_expression\": \"*/10 * * * *\"\n   }\n}\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n\n#### Body\n\nInclude a [job_scheduler object]() with updated fields in the request body.\n\n### Response {#put-response}\n\nReturns a [job_scheduler object]() with the updated fields.\n\n#### Example JSON body\n\n```json\n{\n    \"backup_job_settings\": {\n        \"cron_expression\": \"*/10 * * * *\",\n        \"enabled\": true\n    },\n    \"bdb_usage_report_job_settings\": {\n        \"cron_expression\": \"0 */1 * * *\",\n        \"enabled\": false,\n        \"file_retention_days\": 365\n    },\n    \"cert_rotation_job_settings\": {\n        \"cron_expression\": \"0 * * * *\",\n        \"enabled\": true,\n        \"expiry_days_before_rotation\": 60\n    },\n    \"log_rotation_job_settings\": {\n        \"cron_expression\": \"*/5 * * * *\",\n        \"enabled\": true\n    },\n    \"node_checks_job_settings\": {\n        \"cron_expression\": \"0 * * * *\",\n        \"enabled\": true\n    },\n    \"rotate_ccs_job_settings\": {\n        \"cron_expression\": \"*/5 * * * *\",\n        \"enabled\": true,\n        \"file_suffix\": \"5min\",\n        \"rotate_max_num\": 24\n    }\n}\n```\n\n#### Status codes {#put-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | No error. |\n| [400 Bad Request](https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request) | Bad content provided. |\n| [409 Conflict](https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict) | Attempting to configure the job_scheduler while it is busy with another configuration change. In this context, this is a temporary condition and the request should be re-attempted later. |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00",
  "children": []
}