REST API for Oracle Enterprise Manager

Fleet Create Archival Backups

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/{raTargetId}/archivalBackups/protectionPolicy/{protectionPolicyName}

Create archival backups for all protected databases in a protection policy on a Recovery Appliance. This API requires ZDLRA Management Pack to be enabled on the Recovery Appliance.

Request

Path Parameters

protectionPolicyName(required): string
Protection policy name.
Example:
```
SILVER
```
raTargetId(required): string
Recovery Appliance Target id.
Example:
```
F76BBCCBD8A0D4719A8AA588375FA8BE
```

Header Parameters

ORCL-EM-ZDLRATARGET-AUTHORIZATION(required):
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, the system will use preferred credentials.
Example:
```
NAMED:ORSADMIN
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Protected database's unique name

Match All

Protected database's unique name

Show Source

CreateArchivalBackupDetailsPolicyLevel

Request details for creating archival backups for a single protected database.

{
    "type":"object",
    "description":"Protected database's unique name",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBackupDetailsPolicyLevel"
        }
    ]
}

Nested Schema : CreateArchivalBackupDetailsPolicyLevel

Request details for creating archival backups for a single protected database.

Match One Schema

Show Source

CreateArchivalBackupsPolicyLevelRecurring

Protection policy level recurring request for archival backups creation.
object CreateArchivalBackupsPolicyLevelOnetime

Protection policy level Onetime request for archival backups creation.

{
    "description":"Request details for creating archival backups for a single protected database.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBackupsPolicyLevelRecurring"
        },
        {
            "$ref":"#/components/schemas/CreateArchivalBackupsPolicyLevelOnetime"
        }
    ]
}

Nested Schema : CreateArchivalBackupsPolicyLevelRecurring

Protection policy level recurring request for archival backups creation.

Match All

Protection policy level recurring request for archival backups creation.

Show Source

object CreateArchivalBackupsPolicyLevelRecurringDetails

Protection policy level recurring request details for archival backups creation.
object ScheduleArchivalBackups

Schedule for recurring archival backups creation. If the schedule option is not provided, the archival backup creation is considered one-time.

{
    "description":"Protection policy level recurring request for archival backups creation.",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBackupsPolicyLevelRecurringDetails"
        },
        {
            "$ref":"#/components/schemas/ScheduleArchivalBackups"
        }
    ]
}

Nested Schema : CreateArchivalBackupsPolicyLevelOnetime

Type: object

Protection policy level Onetime request for archival backups creation.

Show Source

archivalBackups(required): array archivalBackups

Protection policy level request details for archival backups creation.

{
    "description":"Protection policy level Onetime request for archival backups creation.",
    "type":"object",
    "required":[
        "archivalBackups"
    ],
    "properties":{
        "archivalBackups":{
            "description":"Protection policy level request details for archival backups creation.",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
                    },
                    {
                        "$ref":"#/components/schemas/RestoreUsingTime"
                    },
                    {
                        "$ref":"#/components/schemas/OneTimeArchivalBkupUsingRestoreTime"
                    }
                ]
            }
        }
    }
}

Nested Schema : CreateArchivalBackupsPolicyLevelRecurringDetails

Type: object

Protection policy level recurring request details for archival backups creation.

Show Source

archivalBackups(required): array archivalBackups

Protection policy level request details for archival backups creation.

{
    "description":"Protection policy level recurring request details for archival backups creation.",
    "type":"object",
    "required":[
        "archivalBackups"
    ],
    "properties":{
        "archivalBackups":{
            "description":"Protection policy level request details for archival backups creation.",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
                    },
                    {
                        "$ref":"#/components/schemas/RestoreUsingTime"
                    },
                    {
                        "$ref":"#/components/schemas/RecurringArchivalBkupDetails"
                    }
                ]
            }
        }
    }
}

Nested Schema : ScheduleArchivalBackups

Type: object

Schedule for recurring archival backups creation. If the schedule option is not provided, the archival backup creation is considered one-time.

Show Source

schedule: object ScheduleRAOperations

Schedule for deployment procedure or job.

{
    "description":"Schedule for recurring archival backups creation. If the schedule option is not provided, the archival backup creation is considered one-time.",
    "type":"object",
    "properties":{
        "schedule":{
            "$ref":"#/components/schemas/ScheduleRAOperations"
        }
    }
}

Nested Schema : archivalBackups

Type: array

Protection policy level request details for archival backups creation.

Show Source

Array of: items

{
    "description":"Protection policy level request details for archival backups creation.",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
            },
            {
                "$ref":"#/components/schemas/RestoreUsingTime"
            },
            {
                "$ref":"#/components/schemas/RecurringArchivalBkupDetails"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

object CreateArchivalBackupBasicDetails

Basic request details for create archival backups API
object RestoreUsingTime

Restore using time option for create archival backups
allOf RecurringArchivalBkupDetails

Create archival backup using restore time

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
        },
        {
            "$ref":"#/components/schemas/RestoreUsingTime"
        },
        {
            "$ref":"#/components/schemas/RecurringArchivalBkupDetails"
        }
    ]
}

Nested Schema : RecurringArchivalBkupDetails

Create archival backup using restore time

Match All

Create archival backup using restore time

Show Source

object RecurringArchivalBkupRecoveryNamePrefix

Create archival backup using restore from time.

{
    "description":"Create archival backup using restore time",
    "allOf":[
        {
            "$ref":"#/components/schemas/RecurringArchivalBkupRecoveryNamePrefix"
        }
    ]
}

Nested Schema : CreateArchivalBackupBasicDetails

Type: object

Basic request details for create archival backups API

Show Source

attributeSetName(required): string

Attribute set name
comments: string

User provided comments.
compressionAlgorithm: string

Allowed Values: [ "BASIC", "LOW", "MEDIUM", "HIGH", "OFF" ]

Recovery Appliance Compression Algorithm.
encryptionAlgorithm: string

Allowed Values: [ "AES128", "AES192", "AES256", "OFF" ]

Recovery Appliance Encryption Algorithm.
format: string

The naming format of the output archival backup pieces. Follows the same rules as the RMAN FORMAT parameter.
keepFor: string

Duration value used to set the keep until date for the archival backups to be created. Value is in ISO 8601 duration format. Examples - P2D (2 days), P3Y (3 years), P3W (3 weeks)

Example: P30D

{
    "type":"object",
    "description":"Basic request details for create archival backups API",
    "required":[
        "attributeSetName"
    ],
    "properties":{
        "attributeSetName":{
            "type":"string",
            "description":"Attribute set name"
        },
        "format":{
            "type":"string",
            "description":"The naming format of the output archival backup pieces. Follows the same rules as the RMAN FORMAT parameter."
        },
        "keepFor":{
            "type":"string",
            "description":"Duration value used to set the keep until date for the archival backups to be created. Value is in ISO 8601 duration format. Examples - P2D (2 days), P3Y (3 years), P3W (3 weeks)",
            "example":"P30D"
        },
        "compressionAlgorithm":{
            "$ref":"#/components/schemas/CompressionAlgorithmEnum"
        },
        "encryptionAlgorithm":{
            "$ref":"#/components/schemas/EncryptionAlgorithmEnum"
        },
        "comments":{
            "type":"string",
            "description":"User provided comments."
        }
    }
}

Nested Schema : RestoreUsingTime

Type: object

Restore using time option for create archival backups

Show Source

restoreUsing(required): string

Allowed Values: [ "RESTORE_TIME" ]

Create Archival backup using this restore time.

{
    "type":"object",
    "description":"Restore using time option for create archival backups",
    "required":[
        "restoreUsing"
    ],
    "properties":{
        "restoreUsing":{
            "$ref":"#/components/schemas/RestoreUsingTimeEnum"
        }
    }
}

Nested Schema : RecurringArchivalBkupRecoveryNamePrefix

Type: object

Create archival backup using restore from time.

Show Source

recoveryPointNamePrefix: string

Recovery point name prefix to be used to name the recovery point. The prefix followed by the timestamp value will be used.

Example: QuarterlyBackup

{
    "description":"Create archival backup using restore from time.",
    "properties":{
        "recoveryPointNamePrefix":{
            "type":"string",
            "description":"Recovery point name prefix to be used to name the recovery point. The prefix followed by the timestamp value will be used.",
            "example":"QuarterlyBackup"
        }
    }
}

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

Type: array

Protection policy level request details for archival backups creation.

Show Source

Array of: items

{
    "description":"Protection policy level request details for archival backups creation.",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
            },
            {
                "$ref":"#/components/schemas/RestoreUsingTime"
            },
            {
                "$ref":"#/components/schemas/OneTimeArchivalBkupUsingRestoreTime"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

object CreateArchivalBackupBasicDetails

Basic request details for create archival backups API
object RestoreUsingTime

Restore using time option for create archival backups
allOf OneTimeArchivalBkupUsingRestoreTime

Create archival backup using restore time

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
        },
        {
            "$ref":"#/components/schemas/RestoreUsingTime"
        },
        {
            "$ref":"#/components/schemas/OneTimeArchivalBkupUsingRestoreTime"
        }
    ]
}

Nested Schema : OneTimeArchivalBkupUsingRestoreTime

Create archival backup using restore time

Match All

Create archival backup using restore time

Show Source

object CreateArchivalBkupUsingRestoreTime

Create archival backup using restore from time.
object ArchivalRestorePointName

Archival Restore Point name - applicable only for one time archival backups

{
    "description":"Create archival backup using restore time",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBkupUsingRestoreTime"
        },
        {
            "$ref":"#/components/schemas/ArchivalRestorePointName"
        }
    ]
}

Nested Schema : CreateArchivalBkupUsingRestoreTime

Type: object

Create archival backup using restore from time.

Show Source

restoreUntilTime: string

Restore from time to be used for creating archival backups. Format is YYYY-MM-DDTHH:mm:ssZ in UTC timezone. If restoreUsing is RESTORE_TIME but restoreUntilTime is not specified or null/empty, then the archival backup will be created using the latest backup available on the RA.

Example: 2022-09-21T06:00:00.000Z

{
    "description":"Create archival backup using restore from time.",
    "properties":{
        "restoreUntilTime":{
            "type":"string",
            "description":"Restore from time to be used for creating archival backups. Format is YYYY-MM-DDTHH:mm:ssZ in UTC timezone. If restoreUsing is RESTORE_TIME but restoreUntilTime is not specified or null/empty, then the archival backup will be created using the latest backup available on the RA.",
            "example":"2022-09-21T06:00:00.000Z"
        }
    }
}

Nested Schema : ArchivalRestorePointName

Type: object

Archival Restore Point name - applicable only for one time archival backups

Show Source

restorePoint: string

Restore point name to be used for naming the archival backup. If not specified, archival backups will be given a default name KEEP_BACKUP_timestamp.

{
    "description":"Archival Restore Point name - applicable only for one time archival backups",
    "properties":{
        "restorePoint":{
            "type":"string",
            "description":"Restore point name to be used for naming the archival backup. If not specified, archival backups will be given a default name KEEP_BACKUP_timestamp."
        }
    }
}

Examples

Response

Supported Media Types

application/json

202 Response

Accepted

Headers

Content-Location:

Execution details of the deployment procedure submitted.

Root Schema : ArchivalBackupsDpSubmissionDetails

Type: object

Archival backups deployment procedure submission details

Show Source

executionId: string

Deployment procedure execution id
instanceId: string

Instance Id of the submitted deployment procedure
instanceName: string

Instance name of the submitted deployment procedure
procedureId: string

Deployment procedure submission id
submissionBy: string

Name of the Enterprise Manager user who submitted the deployment procedure
submissionName: string

Name of the submitted deployment procedure

{
    "type":"object",
    "description":"Archival backups deployment procedure submission details",
    "properties":{
        "submissionName":{
            "type":"string",
            "description":"Name of the submitted deployment procedure"
        },
        "submissionBy":{
            "type":"string",
            "description":"Name of the Enterprise Manager user who submitted the deployment procedure"
        },
        "executionId":{
            "type":"string",
            "description":"Deployment procedure execution id"
        },
        "procedureId":{
            "type":"string",
            "description":"Deployment procedure submission id"
        },
        "instanceId":{
            "type":"string",
            "description":"Instance Id of the submitted deployment procedure"
        },
        "instanceName":{
            "type":"string",
            "description":"Instance name of the submitted deployment procedure"
        }
    }
}

400 Response

Bad Request. The payload is null or missing some parameters

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

code: string

Status code of the error.

Example: IllegalArgument
message: string

A descriptive error message.

Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401 Response

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

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

code: string

Status code of the error.

Example: IllegalArgument
message: string

A descriptive error message.

Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

code: string

Status code of the error.

Example: IllegalArgument
message: string

A descriptive error message.

Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

404 Response

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

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

code: string

Status code of the error.

Example: IllegalArgument
message: string

A descriptive error message.

Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

409 Response

Conflict

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

code: string

Status code of the error.

Example: IllegalArgument
message: string

A descriptive error message.

Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

code: string

Status code of the error.

Example: IllegalArgument
message: string

A descriptive error message.

Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503 Response

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

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

code: string

Status code of the error.

Example: IllegalArgument
message: string

A descriptive error message.

Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}