ActionPlansResource


Create an action plan


POST https://example.com/api/cloud/actionplans

Roles : [ROLE_ACTION_PLAN_MANAGE]

Content-Type : actionplan Accept : actionplan

Error Codes

  • AP-11 - The supplied entry sequence for the action plan is not valid
  • AP-12 - The supplied entry for the action plan requires a virtual machine link
  • AP-26 - Action plan entry configuration does not match the JSON schema
  • AP-5 - The action plan entry collection is empty
  • AP-6 - The collection of entries in the action plan contains non-unique sequences
  • AP-7 - The collection of entries in the action plan contains null elements
  • AP-9 - Unknown action plan entry type

Example

List action plan entry templates


GET https://example.com/api/cloud/actionplans

Roles : [ROLE_ACTION_PLAN_VIEW]

Example

List action plans


GET https://example.com/api/cloud/actionplans

Roles : [ROLE_ACTION_PLAN_VIEW]

Parameter Type Default Value Description
startwith Integer 0 The first element to be retrieved of the filtered search
by String name Order by
has String If present filter to apply in the search.
limit Integer 25 The number of entities to retrieve
asc Boolean true If the value of the 'by' parameter must be sorted in ascending order (true) or descending order (false)

Accept : actionplans

Example

List action plans flat


List action plans with expanded alert and cron-based schedule entities instead of links

GET https://example.com/api/cloud/actionplans

Roles : [ROLE_ACTION_PLAN_VIEW]

Parameter Type Default Value Description
startwith Integer 0 The first element to be retrieved of the filtered search
by String name Order by
has String Wildcard filter for name of the action plan
limit Integer 25 The number of entities to retrieve
asc Boolean true If the value of the 'by' parameter must be sorted in ascending order (true) or descending order (false)

Accept : actionplansflat

Example

Delete an action plan


DELETE https://example.com/api/cloud/actionplans/{actionplan}

Roles : [ROLE_ACTION_PLAN_MANAGE]

Example

Get an action plan


GET https://example.com/api/cloud/actionplans/{actionplan}

Roles : [ROLE_ACTION_PLAN_VIEW]

Accept : actionplan

Error Codes

  • AP-0 - The requested action plan does not exist

Example

Upate an action plan


PUT https://example.com/api/cloud/actionplans/{actionplan}

Roles : [ROLE_ACTION_PLAN_MANAGE]

Content-Type : actionplan Accept : actionplan

Error Codes

  • AP-0 - The requested action plan does not exist

Example

List tasks on an action plan


GET https://example.com/api/cloud/actionplans/{actionplan}/tasks

Roles : [ROLE_ACTION_PLAN_VIEW]

Accept : tasks

Error Codes

  • AP-0 - The requested action plan does not exist

Example

Get a task on an action plan


GET https://example.com/api/cloud/actionplans/{actionplan}/tasks/{id}

Roles : [ROLE_ACTION_PLAN_VIEW]

Accept : task

Error Codes

  • AP-0 - The requested action plan does not exist
  • AP-1 - The requested action plan task has an unexpected type
  • TASK-1 - The requested task does not exist

Execute an action plan


POST https://example.com/api/cloud/actionplans/{actionplan}/action/execute

Roles : [ROLE_ACTION_PLAN_MANAGE]

Accept : acceptedrequest

Error Codes

  • AP-0 - The requested action plan does not exist