Create Maintenance Schedule

POST 
/aggregates/maintenance/scheduler/jobs/orgId/:orgId

Create a new maintenance schedule using cron time expression.

Request

Path Parameters

orgId stringrequired

The Organization ID for which you want to get the active maintenance schedules.

Query Parameters

time_expression stringrequired

When the maintenance schedule should be executed. Defined similarly to Cron job time format, with one more field (seconds) in the beginning. For example: 0 0 0 ? * MON

scheduler_type stringrequired

Use the following value: time-based

application/json

Body

required

any

Responses

200

Success.

application/json

Schema

Schema

any

Example (from schema)

{
  "status": {
    "code": 200,
    "message": "Time-based schedule successfully created."
  },
  "responseCreated": "2021-08-11T12:17:04.308417Z",
  "response": {
    "job_id": "73274ded-b1cf-4c9b-bf25-c8d2e418ef90",
    "time_expression": "0 0 0 ? * MON",
    "scheduler_type": "time-based/maintenance",
    "created_at": "2021-06-17T12:17:03.964072Z",
    "created_by_user": "devUser"
  }
}

Example

{
  "status": {
    "code": 200,
    "message": "Time-based schedule successfully created."
  },
  "responseCreated": "2021-08-11T12:17:04.308417Z",
  "response": {
    "job_id": "73274ded-b1cf-4c9b-bf25-c8d2e418ef90",
    "time_expression": "0 0 0 ? * MON",
    "scheduler_type": "time-based/maintenance",
    "created_at": "2021-06-17T12:17:03.964072Z",
    "created_by_user": "devUser"
  }
}

401

This error will occur if calling user does not have access right for the API.

404

This error will occur if the org identified by orgId does not exist.

500

A server error occurred. Check the logs for more details.

Loading...