Jump to

• Request
• Response

Fleet Remove Protected Databases

post

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

Remove protected databases 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 protected databases to be removed from the Recovery Appliance.

Show Source

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

{
    "description":"List of protected databases to be removed from the Recovery Appliance.",
    "type":"object",
    "required":[
        "raTargetNames"
    ],
    "properties":{
        "raTargetNames":{
            "description":"List of protected databases to be removed from one or more Recovery Appliances.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RemoveProtectedDatabasesPerTarget"
            }
        },
        "schedule":{
            "$ref":"#/components/schemas/ScheduleRAOperations"
        }
    }
}

Nested Schema : raTargetNames

Type: array

List of protected databases to be removed from one or more Recovery Appliances.

Show Source

• Array of: object RemoveProtectedDatabasesPerTarget
  List of protected databases to be removed from a Recovery Appliance.

{
    "description":"List of protected databases to be removed from one or more Recovery Appliances.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RemoveProtectedDatabasesPerTarget"
    }
}

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 : RemoveProtectedDatabasesPerTarget

Type: object

List of protected databases to be removed from a Recovery Appliance.

Show Source

• protectedDatabases(required): array protectedDatabases
  List of protected databases.
• raAdminCred: string
  Recovery Appliance Administrator Credentials. The format must be NAMED: (e.g. NAMED:ORSADMIN) or PREFERRED: (e.g.PREFERRED:PREF_ORSADMIN). If no value is specified preferred credentials will be used.

  Example: NAMED:ORSADMIN
• raTargetId(required): string
  Recovery Appliance target GUID from which protected databases are to be removed.

  Example: F76BBCCBD8A0D4719A8AA588375FA8BE

{
    "description":"List of protected databases to be removed from a Recovery Appliance.",
    "type":"object",
    "required":[
        "raTargetId",
        "protectedDatabases"
    ],
    "properties":{
        "raTargetId":{
            "example":"F76BBCCBD8A0D4719A8AA588375FA8BE",
            "description":"Recovery Appliance target GUID from which protected databases are to be removed.",
            "type":"string"
        },
        "raAdminCred":{
            "description":"Recovery Appliance Administrator Credentials. The format must be NAMED:<credName> (e.g. NAMED:ORSADMIN) or PREFERRED:<credName> (e.g.PREFERRED:PREF_ORSADMIN). If no value is specified preferred credentials will be used.",
            "type":"string",
            "example":"NAMED:ORSADMIN"
        },
        "protectedDatabases":{
            "description":"List of protected databases.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RemoveProtectedDatabases"
            }
        }
    }
}

Nested Schema : protectedDatabases

Type: array

List of protected databases.

Show Source

• Array of: object RemoveProtectedDatabases
  Details of the protected databases to be removed from a Recovery Appliance.

{
    "description":"List of protected databases.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RemoveProtectedDatabases"
    }
}

Nested Schema : RemoveProtectedDatabases

Type: object

Details of the protected databases to be removed from a Recovery Appliance.

Show Source

• name(required): string
  Protected database target name or database unique name.

{
    "description":"Details of the protected databases to be removed from a Recovery Appliance.",
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"Protected database target name or database unique 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 : ProtectedDatabaseDPSubmissionRemove

Type: object

Protected database deployment procedure status.

Show Source

• code(required): integer
  HTTP status code.

  Example: 202
• executionId(required): string
  Procedure execution id.

  Example: D2931B1862AF72E8E05355044B645556
• instanceName(required): string
  Procedure instance name.

  Example: REMOVE_PROTECTED_DB_120321215846
• message(required): string
  Status of the submitted deployment procedure.

  Example: Submitted successfully
• procedureId(required): string
  Procedure submission id.

  Example: D292F6B09ADA65FAE05355044B64D425
• submissionBy(required): string
  Enterprise Manager user that submitted the procedure.

  Example: SYSMAN
• submissionName(required): string
  Deployment Procedure submission name.

  Example: REMOVE_PROTECTED_DB_120321215846

{
    "description":"Protected database deployment procedure status.",
    "type":"object",
    "required":[
        "code",
        "submissionName",
        "submissionBy",
        "executionId",
        "procedureId",
        "instanceName",
        "message"
    ],
    "properties":{
        "code":{
            "example":"202",
            "description":"HTTP status code.",
            "type":"integer"
        },
        "submissionName":{
            "example":"REMOVE_PROTECTED_DB_120321215846",
            "description":"Deployment Procedure submission name.",
            "type":"string"
        },
        "submissionBy":{
            "example":"SYSMAN",
            "description":"Enterprise Manager user that submitted the procedure.",
            "type":"string"
        },
        "executionId":{
            "example":"D2931B1862AF72E8E05355044B645556",
            "description":"Procedure execution id.",
            "type":"string"
        },
        "procedureId":{
            "example":"D292F6B09ADA65FAE05355044B64D425",
            "description":"Procedure submission id.",
            "type":"string"
        },
        "instanceName":{
            "example":"REMOVE_PROTECTED_DB_120321215846",
            "description":"Procedure instance name.",
            "type":"string"
        },
        "message":{
            "example":"Submitted successfully",
            "description":"Status of the submitted deployment procedure.",
            "type":"string"
        }
    }
}

400 Response

Bad Request. The payload is null or missing some parameters

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

Unauthorized. The user does not have permissions to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested REST API URL is not found.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

409 Response

Conflict

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable. The server is unable to process the request.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top