Job scheduler requests

REST API requests for the job scheduler

Redis Enterprise Software
Method Path Description
GET /v1/job_scheduler Get job scheduler settings
PUT /v1/job_scheduler Update job scheduler settings

Get job scheduler settings 

GET /v1/job_scheduler

Get job scheduler information.

Permissions

Permission name Roles
view_cluster_info admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager

Request

Example HTTP request 

GET /v1/job_scheduler

Headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Response

Returns a job_scheduler object.

Example JSON body 

{
  "backup_job_settings": {
    "cron_expression": "*/5 * * * *",
    "enabled": true
  },
  "bdb_usage_report_job_settings": {
    "cron_expression": "0 */1 * * *",
    "enabled": false,
    "file_retention_days": 365
  },
  "cert_rotation_job_settings": {
    "cron_expression": "0 * * * *",
    "enabled": true,
    "expiry_days_before_rotation": 60
  },
  "log_rotation_job_settings": {
    "cron_expression": "*/5 * * * *",
    "enabled": true
  },
  "node_checks_job_settings": {
    "cron_expression": "0 * * * *",
    "enabled": true
  },
  "redis_cleanup_job_settings": {
    "cron_expression": "0 * * * *"
  },
  "rotate_ccs_job_settings": {
    "cron_expression": "*/5 * * * *",
    "enabled": true,
    "file_suffix": "5min",
    "rotate_max_num": 24
  }
}

Status codes

Code Description
200 OK No error.

Update job scheduler settings 

PUT /v1/job_scheduler

Update job scheduler settings.

Permissions

Permission name Roles
update_cluster admin

Request

Example HTTP request 

PUT /v1/job_scheduler

Example JSON body 

{
   "backup_job_settings": {
     "cron_expression": "*/10 * * * *"
   }
}

Headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Body

Include a job_scheduler object with updated fields in the request body.

Response

Returns a job_scheduler object with the updated fields.

Example JSON body 

{
    "backup_job_settings": {
        "cron_expression": "*/10 * * * *",
        "enabled": true
    },
    "bdb_usage_report_job_settings": {
        "cron_expression": "0 */1 * * *",
        "enabled": false,
        "file_retention_days": 365
    },
    "cert_rotation_job_settings": {
        "cron_expression": "0 * * * *",
        "enabled": true,
        "expiry_days_before_rotation": 60
    },
    "log_rotation_job_settings": {
        "cron_expression": "*/5 * * * *",
        "enabled": true
    },
    "node_checks_job_settings": {
        "cron_expression": "0 * * * *",
        "enabled": true
    },
    "rotate_ccs_job_settings": {
        "cron_expression": "*/5 * * * *",
        "enabled": true,
        "file_suffix": "5min",
        "rotate_max_num": 24
    }
}

Status codes

Code Description
200 OK No error.
400 Bad Request Bad content provided.
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.
RATE THIS PAGE
Back to top ↑