API Reference/Schedules

Schedules

For authentication instructions, see API overview.

Endpoints

get/api/v2/schedules

post/api/v2/schedules

get/api/v2/schedules/:id

put/api/v2/schedules/:id

patch/api/v2/schedules/:id

get

List all schedules

Returns a list of schedules. The schedules are returned in sorted order, with the most recent appearing first.

Query parameters

limitinteger
The number of records to return
pageinteger
The page number
orderstring
The order of the records
sortBystring
The sort of the records
fieldsstring
The filter of the records
pstring
policyFilters
qstring
search query

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/schedules

Response

No response schema

post

Create schedules

Create schedules. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

namestring
timeZonestring
activeboolean
defaultboolean
daysarray

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/schedules \
	-d 'name="string"' \
	-d 'timeZone="string"' \
	-d 'active=true' \
	-d 'default=true' \
	-d 'days="array"'

Response

No response schema

get

Retrieve schedules

Returns a single schedule, which you can request by passing through an id in the url.

Path parameters

idstring
ID of the schedule

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/schedules/:id

Response

No response schema

put

Update schedules

Path parameters

idstring
ID of the schedule

Request body

namestring
timeZonestring
activeboolean
defaultboolean
daysarray

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/schedules/:id \
	-d 'name="string"' \
	-d 'timeZone="string"' \
	-d 'active=true' \
	-d 'default=true' \
	-d 'days="array"'

Response

No response schema

patch

Update schedules soft

Update schedules soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

idstring
ID of the schedule

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/schedules/:id

Response

No response schema