Jump to

• Request
• Response

Fleet Delete Protection Policies

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/actions/bulkDeleteProtectionPolicies

Delete one or more protection policies from one or more Recovery Appliances.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

List of the protection policies to be deleted.

Show Source

• raTargetNames(required): array raTargetNames
  List of protection policies to be deleted from one or more Recovery Appliances.
• schedule: object ScheduleRAOperations
  Schedule for deployment procedure or job.

{
    "description":"List of the protection policies to be deleted.",
    "type":"object",
    "required":[
        "raTargetNames"
    ],
    "properties":{
        "raTargetNames":{
            "description":"List of protection policies to be deleted from one or more Recovery Appliances.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DeleteProtectionPoliciesPerTarget"
            }
        },
        "schedule":{
            "$ref":"#/components/schemas/ScheduleRAOperations"
        }
    }
}

Nested Schema : raTargetNames

Type: array

List of protection policies to be deleted from one or more Recovery Appliances.

Show Source

• Array of: object DeleteProtectionPoliciesPerTarget
  List of protection policies to be deleted from a Recovery Appliance.

{
    "description":"List of protection policies to be deleted from one or more Recovery Appliances.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DeleteProtectionPoliciesPerTarget"
    }
}

Nested Schema : ScheduleRAOperations

Type: object

Schedule for deployment procedure or job.

Show Source

• daysOfTheMonth: string
  Comma-separated list of days. (Required only if frequency is monthly, or yearly. Example, repeat=1d. The valid range is 1 to 30 inclusive)
• daysOfTheWeek: string
  Comma-separated list of days. (Required only if frequency is weekly. Example, repeat=1D. The valid range is 1 to 7 inclusive)
• endTime: string
  End time for the procedure executions (optional). If it is not specified, the procedure runs indefinitely. W3C Time format.

  Example: 2025-12-31T20:00:00UTC, 2025-12-31T20:00:00America/New_York, 2025-12-31T20:00:00Z, 2025-12-31T20:00:00+05:00
• frequency: string
  Allowed Values: [ "INTERVAL", "WEEKLY", "MONTHLY", "YEARLY" ]

  Schedule Frequency Options
• gracePeriod: string
  grace period in minutes (optional)
• monthsOfTheYear: string
  Comma-separated list of months. (Required only if frequency is yearly). Valid range is 1 to 12 inclusive.
• repeat: string
  Frequency with which the job must be repeated.(Required only if frequency is set to interval.)
• startTime: string
  Time when the procedure is to start executing. W3C Time format.

  Example: 2024-12-31T20:00:00UTC, 2024-12-31T20:00:00America/New_York, 2024-12-31T20:00:00Z, 2024-12-31T20:00:00+05:00

{
    "description":"Schedule for deployment procedure or job.",
    "type":"object",
    "properties":{
        "startTime":{
            "example":"2024-12-31T20:00:00UTC, 2024-12-31T20:00:00America/New_York, 2024-12-31T20:00:00Z, 2024-12-31T20:00:00+05:00",
            "type":"string",
            "description":"Time when the procedure is to start executing. W3C Time format."
        },
        "endTime":{
            "example":"2025-12-31T20:00:00UTC, 2025-12-31T20:00:00America/New_York, 2025-12-31T20:00:00Z, 2025-12-31T20:00:00+05:00",
            "type":"string",
            "description":"End time for the procedure executions (optional). If it is not specified, the procedure runs indefinitely. W3C Time format."
        },
        "frequency":{
            "$ref":"#/components/schemas/ScheduleFrequencyOptions"
        },
        "repeat":{
            "type":"string",
            "description":"Frequency with which the job must be repeated.(Required only if frequency is set to interval.)"
        },
        "daysOfTheWeek":{
            "type":"string",
            "description":"Comma-separated list of days. (Required only if frequency is weekly. Example, repeat=1D. The valid range is 1 to 7 inclusive)"
        },
        "daysOfTheMonth":{
            "type":"string",
            "description":"Comma-separated list of days. (Required only if frequency is monthly, or yearly. Example, repeat=1d. The valid range is 1 to 30 inclusive)"
        },
        "monthsOfTheYear":{
            "type":"string",
            "description":"Comma-separated list of months. (Required only if frequency is yearly). Valid range is 1 to 12 inclusive."
        },
        "gracePeriod":{
            "type":"string",
            "description":"grace period in minutes (optional)"
        }
    }
}

Nested Schema : DeleteProtectionPoliciesPerTarget

Type: object

List of protection policies to be deleted from a Recovery Appliance.

Show Source

• protectionPolicies(required): array protectionPolicies
  List of protection policies.
• raAdminCred: string
  Recovery Appliance administrator credentials.
• raTargetId(required): string
  Recovery Appliance target GUID on which protection policies are to be created, deleted or updated.

{
    "description":"List of protection policies to be deleted from a Recovery Appliance.",
    "type":"object",
    "required":[
        "raTargetId",
        "protectionPolicies"
    ],
    "properties":{
        "raTargetId":{
            "description":"Recovery Appliance target GUID on which protection policies are to be created, deleted or updated.",
            "type":"string"
        },
        "raAdminCred":{
            "description":"Recovery Appliance administrator credentials.",
            "type":"string"
        },
        "protectionPolicies":{
            "description":"List of protection policies.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DeleteProtectionPolicies"
            }
        }
    }
}

Nested Schema : protectionPolicies

Type: array

List of protection policies.

Show Source

• Array of: object DeleteProtectionPolicies
  Protection policies to be deleted.

{
    "description":"List of protection policies.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DeleteProtectionPolicies"
    }
}

Nested Schema : DeleteProtectionPolicies

Type: object

Protection policies to be deleted.

Show Source

• name(required): string
  Protection policy name.

{
    "description":"Protection policies to be deleted.",
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"Protection policy name.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted

Headers

• Content-Location:
  Execution details of the deployment procedure submitted.

Body ()

Root Schema : ProtectionPolicyDPSubmission

Type: object

Protection policy deployment procedure status.

Show Source

• code(required): integer
  HTTP status code.
• executionId(required): string
  Procedure submission id.
• instanceName(required): string
  Procedure instance name.
• procedureId(required): string
  Procedure submission id.
• submissionBy(required): string
  Name of the Enterprise Manager user who submitted the deployment procedure.
• submissionName(required): string
  Name of the submitted deployment procedure.

{
    "description":"Protection policy deployment procedure status.",
    "type":"object",
    "required":[
        "code",
        "submissionName",
        "submissionBy",
        "executionId",
        "procedureId",
        "instanceName"
    ],
    "properties":{
        "code":{
            "description":"HTTP status code.",
            "type":"integer"
        },
        "submissionName":{
            "description":"Name of the submitted deployment procedure.",
            "type":"string"
        },
        "submissionBy":{
            "description":"Name of the Enterprise Manager user who submitted the deployment procedure.",
            "type":"string"
        },
        "executionId":{
            "description":"Procedure submission id.",
            "type":"string"
        },
        "procedureId":{
            "description":"Procedure submission id.",
            "type":"string"
        },
        "instanceName":{
            "description":"Procedure instance name.",
            "type":"string"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

403 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

Response sent back as an Error in case required privileges are missing

Show Source

• missingPrivileges: array missingPrivileges
  Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Response sent back as an Error in case required privileges are missing

Show Source

• object ErrorResponse
  Response sent back in the case of an Error

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Nested Schema : missingPrivileges

Type: array

Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

404 Response

Not Found

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

409 Response

Duplicate Resource

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top