get

/plans/{id}

Gets the details of a particular Protection Plan

Request Parameters

1 Path Parameter
2 Headers

Responses

Ok

Schema
object
enabled
boolean

State of Protection Plan

1 validation
id
string

ID of the Protection Plan

1 validation
name
string

Name of to the Protection Plan

1 validation
policy_id
string

ID of the policy attached to the Protection Plan

1 validation
policy_name
string

Name of the policy attached to the Protection Plan

1 validation
cross_region_policy_id
string

ID of the Cross-Region policy attached to the Protection Plan

1 validation
cross_region_policy_name
string

Name of the Cross-Region policy attached to the Protection Plan

1 validation
cross_account_policy_id
string

ID of the Cross-Account policy attached to the Protection Plan

1 validation
cross_account_policy_name
string

Name of the Cross-Account policy attached to the Protection Plan

1 validation
scripts
object

Scripts to run pre and post the Snapshot operation. A script is valid if either of preSnapshotScript and postSnapshotScript or both are present. Mutually exclusive to vss_enabled property for AWS.

start_time
string

Start time of the Protection Plan

1 validation
start_time_timezone
string

Time zone of start time for the Protection Plan

1 validation
tags
array[object]
resources
array[object]

resources associated with Resource based Protection Plan

vss_enabled
boolean

AWS only. Flag to indicate whether to use AWS VSS mechanism for Snapshot. Mutually exclusive to scripts property.

2 validations

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
id
$$.env
No $$.env variables are being used in this request.