Plan API Reference
API Reference/Plan

Plan

For authentication instructions, see API overview.

Endpoints

get/api/v2/plan-executions
post/api/v2/plan-executions
get/api/v2/plan-executions/:id
put/api/v2/plan-executions/:id
patch/api/v2/plan-executions/:id
delete/api/v2/plan-executions/deleted/:id
get

List all plan executions

Returns a list of plan executions. The plan executions 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/plan-executions

Response

No response schema
post

Create plan executions

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

Request body

  • fromDatestring
  • toDatestring

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/plan-executions \
	-d 'fromDate="2023-04-19"' \
	-d 'toDate="2023-04-19"'

Response

No response schema
get

Retrieve plan executions

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

Path parameters

  • idstring

    ID of the plan execution

Request

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

Response

No response schema
put

Update plan executions

Path parameters

  • idstring

    ID of the plan execution

Request body

  • fromDatestring
  • toDatestring

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/plan-executions/:id \
	-d 'fromDate="2023-04-19"' \
	-d 'toDate="2023-04-19"'

Response

No response schema
patch

Update plan executions soft

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

Path parameters

  • idstring

    ID of the plan execution

Request

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

Response

No response schema
delete

Delete plan executions

Path parameters

  • idstring

    ID of the plan execution

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/plan-executions/deleted/:id

Response

No response schema