Oracle Perfhub API

openapi: 3.2.0
info:
  description: "Use the Database Management API to monitor and manage resources such as\nOracle Databases, MySQL Databases, and External Database Systems. \nFor more information, see [Database Management](/iaas/database-management/home.htm).\n"
  title: Database Management Perfhub API
  version: '20201101'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/e7e7138b3ad5254432bc9203d07c08e1e84e00d89a283cd6935a4ef61a6929cf.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Database Management API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/e7e7138b3ad5254432bc9203d07c08e1e84e00d89a283cd6935a4ef61a6929cf.yaml
    what: the harvested document for Database Management API
servers:
- url: http://dbmgmt.{region}.oci.oraclecloud.com/20201101
- url: https://dbmgmt.{region}.oci.oraclecloud.com/20201101
tags:
- name: perfhub
paths:
  /managedDatabases/{managedDatabaseId}/actions/modifySnapshotSettings:
    post:
      description: 'Modifies the snapshot settings for the specified Database.

        '
      operationId: ModifySnapshotSettings
      parameters:
      - $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/NamedCredentialIdHeader'
      responses:
        204:
          description: The snapshot settings have been successfully modified.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Modifies the snapshot settings for the specified Database.
      tags:
      - perfhub
      x-example: "POST /v1/databases/<var>&lt;databaseId&gt;</var>/actions/modifySnapshotSettings\nHost: database.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n   \"retention\" : 525600\n   \"interval\" : 120\n}\n"
      x-related-resource: '#/definitions/ManagedDatabase'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifySnapshotSettingsDetails'
        description: Request to modify snapshot settings for a Database.
        required: true
components:
  parameters:
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    ManagedDatabaseIdPathParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
      in: path
      name: managedDatabaseId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    NamedCredentialIdHeader:
      description: The OCID of the Named Credential.
      in: header
      name: opc-named-credential-id
      required: false
      x-default-description: 'null'
      schema:
        type: string
  schemas:
    Error:
      description: Error Information.
      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
      required:
      - code
      - message
    ModifySnapshotSettingsDetails:
      description: Details to modify the AWR snapshot settings for a database.
      properties:
        interval:
          description: The interval time in minutes. Acceptable values are 0, 10 to 527040 (inclusive), and null.
          maximum: 527040
          minimum: 0
          type: integer
        retention:
          description: The retention time in minutes. Acceptable values are 0, 1440 to 52596000 (inclusive), and null.
          maximum: 52596000
          minimum: 0
          type: integer
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    content-location:
      description: Content Location of the resource.
      format: uri-reference
      type: string
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    location:
      description: Location of the resource.
      format: uri-reference
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

        '
      type: string
  x-properties:
    Sunset:
      description: 'Sunset date when this operation will stop working, in <HTTP-date> format, Fri, 29 Jan 2027 00:00:00 GMT.

        '
      type: string
    cloudDbSystemConnectorCredentialName:
      description: 'The name of the credential information that used to connect to the DB system resource.

        The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters,

        and length of "y" has a maximum of 199 characters. The name strings can contain letters,

        numbers and the underscore character only. Other characters are not valid, except for

        the "." character that separates the "x" and "y" portions of the name.

        *IMPORTANT* - The name must be unique within the OCI region the credential is being created in.

        If you specify a name that duplicates the name of another credential within the same OCI region,

        you may overwrite or corrupt the credential that is already using the name.


        For example: inventorydb.abc112233445566778899

        '
      maxLength: 255
      minLength: 1
      type: string
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only the String type is supported.

            '
          type: object
        description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

          Example: `{"CostCenter": "42"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

        Example: `{"Operations": {"CostCenter": "42"}}`

        '
      type: object
    externalDbSystemConnectorCredentialName:
      description: 'The name of the credential information that used to connect to the DB system resource.

        The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters,

        and length of "y" has a maximum of 199 characters. The name strings can contain letters,

        numbers and the underscore character only. Other characters are not valid, except for

        the "." character that separates the "x" and "y" portions of the name.

        *IMPORTANT* - The name must be unique within the OCI region the credential is being created in.

        If you specify a name that duplicates the name of another credential within the same OCI region,

        you may overwrite or corrupt the credential that is already using the name.


        For example: inventorydb.abc112233445566778899

        '
      maxLength: 255
      minLength: 1
      type: string
    externalLicenseModel:
      description: 'The Oracle license model that applies to the external database.

        '
      enum:
      - LICENSE_INCLUDED
      - BRING_YOUR_OWN_LICENSE
      type: string
    freeformTags:
      additionalProperties:
        type: string
      description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

        For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

        Example: `{"Department": "Finance"}`

        '
      type: object
    licenseModel:
      description: 'The Oracle license model that applies to the database management resources.

        '
      enum:
      - LICENSE_INCLUDED
      - BRING_YOUR_OWN_LICENSE
      type: string
    lifecycleState:
      description: The current lifecycle state of the database resource.
      enum:
      - CREATING
      - ACTIVE
      - INACTIVE
      - UPDATING
      - DELETING
      - DELETED
      - FAILED
      type: string
    securityAttributes:
      additionalProperties:
        additionalProperties:
          description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".

            '
          type: object
        description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.


          Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

          '
        type: object
      description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.

        For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


        Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

          Example: `{"free-tier-retained": "true"}`

          '
        type: object
      description: 'System tags for this resource. Each key is predefined and scoped to a namespace.

        For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

        System tags can be viewed by users, but can only be created by the system.


        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-oracle-package: com.oracle.oci.dpd.dbmgmt