Get Maintenance Schedules

Get Maintenance Schedules

Using this method, you can get all maintenance schedules with or without specific parameters

Request
URI
GET
https://{api_host}/suite-api/api/maintenanceschedules
COPY
Query Parameters
string of array
id
Optional

Maintenance schedule identifiers

string of array
name
Optional

Maintenance schedule names or keys

string of array
resourceId
Optional

List of Object identifiers

integer
page
Optional
Constraints: default: 0

Page number from which data needs to be displayed (0-based)

integer
pageSize
Optional
Constraints: default: 1000

Expected number of entries per page

Authentication
This operation uses the following authentication methods.
Responses
200

The Maintenance Schedules that match the criteria specified

Returns maintenance-schedules of type(s) application/json 
"{\n  \"schedules\" : [ {\n    \"id\" : \"a267a43c-7bcb-4cb8-b890-b6a5d9fa90ba\",\n    \"key\" : \"daily-ms1\",\n    \"schedule\" : {\n      \"hour\" : 3,\n      \"minuteOfTheHour\" : 0,\n      \"duration\" : 180,\n      \"scheduleType\" : \"DAILY\",\n      \"recurrence\" : 1,\n      \"expirationDate\" : \"01/20/2050\",\n      \"timeZone\" : \"Asia/Yerevan\"\n    }\n  }, {\n    \"id\" : \"795adffc-24f4-469d-9103-ccb96cf42864\",\n    \"key\" : \"monthly-ms1\",\n    \"schedule\" : {\n      \"hour\" : 3,\n      \"minuteOfTheHour\" : 0,\n      \"duration\" : 3,\n      \"scheduleType\" : \"MONTHLY\",\n      \"daysOfTheMonth\" : [ \"1\", \"2\" ],\n      \"months\" : [ 1 ],\n      \"timeZone\" : \"Asia/Yerevan\",\n      \"expireRuns\" : 3\n    }\n  }, {\n    \"id\" : \"6ca3c8f3-d25c-4081-9673-1778398a667f\",\n    \"key\" : \"weekly-ms1\",\n    \"schedule\" : {\n      \"hour\" : 15,\n      \"minuteOfTheHour\" : 3,\n      \"duration\" : 1,\n      \"scheduleType\" : \"WEEKLY\",\n      \"recurrence\" : 5,\n      \"daysOfTheWeek\" : [ \"SATURDAY\", \"SUNDAY\" ],\n      \"timeZone\" : \"Asia/Yerevan\",\n      \"expireRuns\" : 7\n    }\n  } ]\n}"
object
pageInfo
Optional

Represents page information for a paged result

array of object
links
Optional

Collection of links

array of object
schedules
Optional

Collection of maintenance schedules


Code Samples
COPY
                    curl -H 'Authorization: <value>' 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