Create Maintenance Schedules

Create Maintenance Schedules

Using this method, you can create a particular maintenance schedules

Request
URI
POST
https://{api_host}/suite-api/api/maintenanceschedules
COPY
Request Body

The maintenance schedule to be created

maintenance-schedule of type(s) application/json
Required

Show optional properties

{
    "key": "string",
    "schedule": {
        "hour": 0,
        "minuteOfTheHour": 0,
        "duration": 0,
        "scheduleType": "string"
    }
}
"{\n  \"key\" : \"daily-ms1\",\n  \"schedule\" : {\n    \"hour\" : 2,\n    \"minuteOfTheHour\" : 0,\n    \"duration\" : 120,\n    \"scheduleType\" : \"DAILY\",\n    \"recurrence\" : 1,\n    \"timeZone\" : \"Asia/Yerevan\",\n    \"expireRuns\" : 3\n  }\n}"
string As uuid As uuid
id
Optional

Identifier generated by the server for this schedule.

string
key
Required
Constraints: minLength: 1 maxLength: 200

Schedule key provided by user. Cannot be null during creation.

object
schedule
Required

Schedule represents the meta information required by the server to set resources in maintenance mode at the right interval/time. To construct specific schedules, please see some of the static helper utilities in this class.

Authentication
This operation uses the following authentication methods.
Responses
201

The maintenance schedule created

Returns maintenance-schedule of type(s) application/json 
"No Custom Example is Available"
string As uuid As uuid
id
Optional

Identifier generated by the server for this schedule.

string
key
Required
Constraints: minLength: 1 maxLength: 200

Schedule key provided by user. Cannot be null during creation.

object
schedule
Required

Schedule represents the meta information required by the server to set resources in maintenance mode at the right interval/time. To construct specific schedules, please see some of the static helper utilities in this class.


400

Invalid request parameters or request body

Operation doesn't return any data structure

422

A maintenance schedule with the same key already exists

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"key:"string","schedule:"object"}' https://{api_host}/suite-api/api/maintenanceschedules
On This Page
Maintenance Schedules Operations
GET
Get Maintenance Schedules
PUT
Update Maintenance Schedules
POST
Create Maintenance Schedules
DELETE
Delete Maintenance Schedules