Jump to

• Request
• Response

Maintain Recovery Appliance backup wallets

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/databases/actions/maintainBackupConfig

Synchronizes backup wallets for protected databases after the virtual private catalog credentials or trusted certificates for the associated Recovery Appliance change. The ZDLRA Management Pack must be enabled for that Recovery Appliance.

Request

Header Parameters

• ORCL-EM-DBTARGET-AUTHORIZATION:
  Database named credential used to connect to the database target. If omitted, preferred credentials will be used.
• ORCL-EM-HOSTTARGET-AUTHORIZATION:
  Host named credential for an operating system user who can perform database backup and recovery operations. If omitted, preferred credentials will be used.
• ORCL-EM-WALLETTARGET-AUTHORIZATION:
  Named credential containing the password for a password-protected backup wallet.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Maintain Backup Configuration Request schema.

Show Source

• destinationMediaType: string
  Destination media type.

  Example: RA
• schedule: Discriminator: type
  Discriminator: { "propertyName":"type", "mapping":{ "immediately":"#/components/schemas/ScheduleImmediately", "later":"#/components/schemas/ScheduleLater", "repeating":"#/components/schemas/ScheduleRepeating" } }

  Specifies schedule of the deployment procedure.
• targetList: array targetList
  Database targets on which to perform SBT backup wallet maintenance. When specified, only listed targets that require synchronization are processed. When omitted, all database targets currently flagged for maintenance in the Enterprise Manager repository are processed.

{
    "type":"object",
    "description":"Maintain Backup Configuration Request schema.",
    "properties":{
        "destinationMediaType":{
            "type":"string",
            "description":"Destination media type.",
            "example":"RA"
        },
        "targetList":{
            "type":"array",
            "description":"Database targets on which to perform SBT backup wallet maintenance. When specified, only listed targets that require synchronization are processed. When omitted, all database targets currently flagged for maintenance in the Enterprise Manager repository are processed.",
            "items":{
                "type":"object",
                "properties":{
                    "targetName":{
                        "type":"string",
                        "description":"Target name.",
                        "example":"DB1"
                    },
                    "targetType":{
                        "type":"string",
                        "description":"Target type.",
                        "enum":[
                            "oracle_database",
                            "rac_database",
                            "composite"
                        ],
                        "example":"oracle_database"
                    },
                    "databaseCredential":{
                        "type":"string",
                        "description":"Database credentials.",
                        "example":"NAMED:NC_DB1:SYSMAN"
                    },
                    "hostCredential":{
                        "type":"string",
                        "description":"Host credentials.",
                        "example":"NAMED:NC_VMUSER:SYSMAN"
                    }
                }
            }
        },
        "schedule":{
            "description":"Specifies schedule of the deployment procedure.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/ScheduleImmediately"
                },
                {
                    "$ref":"#/components/schemas/ScheduleLater"
                },
                {
                    "$ref":"#/components/schemas/ScheduleRepeating"
                }
            ],
            "discriminator":{
                "propertyName":"type",
                "mapping":{
                    "immediately":"#/components/schemas/ScheduleImmediately",
                    "later":"#/components/schemas/ScheduleLater",
                    "repeating":"#/components/schemas/ScheduleRepeating"
                }
            }
        }
    }
}

Nested Schema : Discriminator: type

Type: object

Discriminator: type

Discriminator Values

• immediately
• later
• repeating

{
    "description":"Specifies schedule of the deployment procedure.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleImmediately"
        },
        {
            "$ref":"#/components/schemas/ScheduleLater"
        },
        {
            "$ref":"#/components/schemas/ScheduleRepeating"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "immediately":"#/components/schemas/ScheduleImmediately",
            "later":"#/components/schemas/ScheduleLater",
            "repeating":"#/components/schemas/ScheduleRepeating"
        }
    }
}

Specifies schedule of the deployment procedure.

Match One Schema

Show Source

• immediately - object ScheduleImmediately
  Schedule immediately.
• later - object ScheduleLater
  Schedule later.
• object Discriminator: repeatFrequency
  Discriminator: { "propertyName":"repeatFrequency", "mapping":{ "WEEKLY":"#/components/schemas/ScheduleWeekly", "MONTHLY":"#/components/schemas/ScheduleMonthly", "YEARLY":"#/components/schemas/ScheduleYearly", "INTERVAL":"#/components/schemas/ScheduleInterval" } }

  Repeating schedule.

{
    "description":"Specifies schedule of the deployment procedure.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleImmediately"
        },
        {
            "$ref":"#/components/schemas/ScheduleLater"
        },
        {
            "$ref":"#/components/schemas/ScheduleRepeating"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "immediately":"#/components/schemas/ScheduleImmediately",
            "later":"#/components/schemas/ScheduleLater",
            "repeating":"#/components/schemas/ScheduleRepeating"
        }
    }
}

Nested Schema : targetList

Type: array

Database targets on which to perform SBT backup wallet maintenance. When specified, only listed targets that require synchronization are processed. When omitted, all database targets currently flagged for maintenance in the Enterprise Manager repository are processed.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Database targets on which to perform SBT backup wallet maintenance. When specified, only listed targets that require synchronization are processed. When omitted, all database targets currently flagged for maintenance in the Enterprise Manager repository are processed.",
    "items":{
        "type":"object",
        "properties":{
            "targetName":{
                "type":"string",
                "description":"Target name.",
                "example":"DB1"
            },
            "targetType":{
                "type":"string",
                "description":"Target type.",
                "enum":[
                    "oracle_database",
                    "rac_database",
                    "composite"
                ],
                "example":"oracle_database"
            },
            "databaseCredential":{
                "type":"string",
                "description":"Database credentials.",
                "example":"NAMED:NC_DB1:SYSMAN"
            },
            "hostCredential":{
                "type":"string",
                "description":"Host credentials.",
                "example":"NAMED:NC_VMUSER:SYSMAN"
            }
        }
    }
}

Nested Schema : ScheduleImmediately

Type: object

Schedule immediately.

Show Source

• type(required): string
  Type of schedule.

  Example: immediately

{
    "type":"object",
    "description":"Schedule immediately.",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "example":"immediately"
        }
    }
}

Nested Schema : ScheduleLater

Type: object

Schedule later.

Show Source

• startTime: date-time
  Date when the deployment procedure is scheduled to start. Specified as a string in the format yyyy/MM/dd HH:mm.

  Example: 2021/08/30 23:00
• timeZone: string
  Java Timezone.

  Example: America/New_York
• type(required): string
  Type of schedule.

  Example: later

{
    "type":"object",
    "description":"Schedule later.",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "example":"later"
        },
        "startTime":{
            "$ref":"#/components/schemas/ScheduleStartTime"
        },
        "timeZone":{
            "$ref":"#/components/schemas/ScheduleTimeZone"
        }
    }
}

Nested Schema : Discriminator: repeatFrequency

Type: object

Discriminator: repeatFrequency

Discriminator Values

• WEEKLY
• MONTHLY
• YEARLY
• INTERVAL

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/ScheduleInterval"
        }
    }
}

Repeating schedule.

Match All

Repeating schedule.

Show Source

• object ScheduleRepeatingBase
  Repeating schedule.

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/ScheduleInterval"
        }
    }
}

Match One Schema

Show Source

• WEEKLY - object ScheduleWeekly
  Repeat value for repeat frequency - weekly.
• MONTHLY - object ScheduleMonthly
  Repeat value for repeat frequency - monthly.
• YEARLY - object ScheduleYearly
  Repeat value for repeat frequency - yearly.
• INTERVAL - object ScheduleInterval
  Repeat value for repeat frequency - interval.

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/ScheduleInterval"
        }
    }
}

Nested Schema : ScheduleRepeatingBase

Type: object

Repeating schedule.

Show Source

• endtime: date-time
  Date when job expires. Specified as a string in the format yyyy/MM/dd HH:mm. If not specified, repeat would be on forever.

  Example: 2021/08/30 23:00
• repeatFrequency(required): string
  Allowed Values: [ "WEEKLY", "MONTHLY", "YEARLY", "INTERVAL" ]

  Repetitive frequency type.
• startTime(required): date-time
  Date when the deployment procedure is scheduled to start. Specified as a string in the format yyyy/MM/dd HH:mm.

  Example: 2021/08/30 23:00
• timeZone: string
  Java Timezone.

  Example: America/New_York
• type(required): string
  Type of schedule.

  Example: repeating

{
    "type":"object",
    "description":"Repeating schedule.",
    "required":[
        "type",
        "startTime",
        "repeatFrequency"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "example":"repeating"
        },
        "startTime":{
            "$ref":"#/components/schemas/ScheduleStartTime"
        },
        "timeZone":{
            "$ref":"#/components/schemas/ScheduleTimeZone"
        },
        "endtime":{
            "$ref":"#/components/schemas/ScheduleEndTime"
        },
        "repeatFrequency":{
            "$ref":"#/components/schemas/ScheduleRepeatFrequency"
        }
    }
}

Nested Schema : ScheduleWeekly

Type: object

Repeat value for repeat frequency - weekly.

Show Source

• days(required): array days
  Days of the week.

{
    "description":"Repeat value for repeat frequency - weekly.",
    "required":[
        "days"
    ],
    "properties":{
        "days":{
            "description":"Days of the week.",
            "type":"array",
            "example":"1,4",
            "items":{
                "$ref":"#/components/schemas/DaysOfTheWeekEnum"
            }
        }
    }
}

Nested Schema : ScheduleMonthly

Type: object

Repeat value for repeat frequency - monthly.

Show Source

• days(required): array days
  Repeat value for monthly.

{
    "description":"Repeat value for repeat frequency - monthly.",
    "required":[
        "days"
    ],
    "properties":{
        "days":{
            "description":"Repeat value for monthly.",
            "type":"array",
            "example":"1,30,31",
            "items":{
                "type":"integer",
                "description":"Day number, int -1, 1..5 representing which day number. -1 represents LAST day."
            }
        }
    }
}

Nested Schema : ScheduleYearly

Type: object

Repeat value for repeat frequency - yearly.

Show Source

• months(required): array months
  Repeat value for yearly.

{
    "description":"Repeat value for repeat frequency - yearly.",
    "required":[
        "months"
    ],
    "properties":{
        "months":{
            "description":"Repeat value for yearly.",
            "type":"array",
            "example":"1,3",
            "items":{
                "type":"integer",
                "description":"Month number, int 1, 2, 3.. representing months Januaray, February, March etc."
            }
        }
    }
}

Nested Schema : ScheduleInterval

Type: object

Repeat value for repeat frequency - interval.

Show Source

• repeatEvery(required): string
  Repeat every N value - m(minutes), h(hours), d(days), w(week).

  Example: 10m, 3h, 5d, 2w

{
    "description":"Repeat value for repeat frequency - interval.",
    "required":[
        "repeatEvery"
    ],
    "properties":{
        "repeatEvery":{
            "description":"Repeat every N value - m(minutes), h(hours), d(days), w(week).",
            "type":"string",
            "example":"10m, 3h, 5d, 2w"
        }
    }
}

Nested Schema : days

Type: array

Days of the week.

Show Source

• Array of: integer
  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7 ]

  Days of the week, Sunday is 1, Monday is 2 etc.

{
    "description":"Days of the week.",
    "type":"array",
    "example":"1,4",
    "items":{
        "$ref":"#/components/schemas/DaysOfTheWeekEnum"
    }
}

Example:

1,4

Nested Schema : days

Type: array

Repeat value for monthly.

Show Source

• Array of: integer
  Day number, int -1, 1..5 representing which day number. -1 represents LAST day.

{
    "description":"Repeat value for monthly.",
    "type":"array",
    "example":"1,30,31",
    "items":{
        "type":"integer",
        "description":"Day number, int -1, 1..5 representing which day number. -1 represents LAST day."
    }
}

Example:

1,30,31

Nested Schema : months

Type: array

Repeat value for yearly.

Show Source

• Array of: integer
  Month number, int 1, 2, 3.. representing months Januaray, February, March etc.

{
    "description":"Repeat value for yearly.",
    "type":"array",
    "example":"1,3",
    "items":{
        "type":"integer",
        "description":"Month number, int 1, 2, 3.. representing months Januaray, February, March etc."
    }
}

Example:

1,3

Nested Schema : items

Type: object

Show Source

• databaseCredential: string
  Database credentials.

  Example: NAMED:NC_DB1:SYSMAN
• hostCredential: string
  Host credentials.

  Example: NAMED:NC_VMUSER:SYSMAN
• targetName: string
  Target name.

  Example: DB1
• targetType: string
  Allowed Values: [ "oracle_database", "rac_database", "composite" ]

  Target type.

  Example: oracle_database

{
    "type":"object",
    "properties":{
        "targetName":{
            "type":"string",
            "description":"Target name.",
            "example":"DB1"
        },
        "targetType":{
            "type":"string",
            "description":"Target type.",
            "enum":[
                "oracle_database",
                "rac_database",
                "composite"
            ],
            "example":"oracle_database"
        },
        "databaseCredential":{
            "type":"string",
            "description":"Database credentials.",
            "example":"NAMED:NC_DB1:SYSMAN"
        },
        "hostCredential":{
            "type":"string",
            "description":"Host credentials.",
            "example":"NAMED:NC_VMUSER:SYSMAN"
        }
    }
}

Examples

Select an example MaintainBackupConfigExample

Back to Top

Response

Supported Media Types

• application/json

202 Response

Tracking details for the submitted deployment procedure.

Headers

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

Body ()

Root Schema : MaintainBackupConfigResponse

Type: object

Response of the operation submitted.

Show Source

• executionId(required): string
  Deployment procedure execution ID.

  Example: DE8676BE8CD73086E053DE0D4B64D288
• location: string
  URI to verify the status of the deployment procedure submitted.

  Example: /em/api/deploymentProcedureInstances/DE8676BE8CD73086E053DE0D4B64D288
• procedureId(required): string
  Deployment procedure submission ID.

  Example: DE8676BE8CD73086E053DE0D4B64D288
• submissionName(required): string
  Name of the deployment procedure submitted.

  Example: MAINTAIN_BACKUP_RA_121222220321
• submittedBy(required): string
  User that submitted the deployment procedure.

  Example: SYSMAN

{
    "description":"Response of the operation submitted.",
    "type":"object",
    "required":[
        "submissionName",
        "submittedBy",
        "executionId",
        "procedureId"
    ],
    "properties":{
        "submissionName":{
            "description":"Name of the deployment procedure submitted.",
            "type":"string",
            "example":"MAINTAIN_BACKUP_RA_121222220321"
        },
        "submittedBy":{
            "description":"User that submitted the deployment procedure.",
            "type":"string",
            "example":"SYSMAN"
        },
        "executionId":{
            "description":"Deployment procedure execution ID.",
            "type":"string",
            "example":"DE8676BE8CD73086E053DE0D4B64D288"
        },
        "procedureId":{
            "description":"Deployment procedure submission ID.",
            "type":"string",
            "example":"DE8676BE8CD73086E053DE0D4B64D288"
        },
        "location":{
            "description":"URI to verify the status of the deployment procedure submitted.",
            "type":"string",
            "example":"/em/api/deploymentProcedureInstances/DE8676BE8CD73086E053DE0D4B64D288"
        }
    }
}

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"
}

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