openapi: 3.2.0
info:
  description: 'Use the Key Management API to manage vaults and keys. For more information, see [Managing Vaults](/Content/KeyManagement/Tasks/managingvaults.htm) and [Managing Keys](/Content/KeyManagement/Tasks/managingkeys.htm).

    '
  license:
    name: Oracle Corporation
  title: Vault Key Management Kms Management API
  version: release
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/6650b193f50d51919ae1a5f31b525097c777bb9e61575a82b12bf5a5fa5c1dea.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Vault Key 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/6650b193f50d51919ae1a5f31b525097c777bb9e61575a82b12bf5a5fa5c1dea.yaml
    what: the harvested document for Vault Key Management API
servers:
- url: /
tags:
- name: kmsManagement
paths:
  /20180608/keys:
    get:
      description: 'Lists the master encryption keys in the specified vault and compartment.


        As a management operation, this call is subject to a Key Management limit that applies to the total number

        of requests across all management read operations. Key Management might throttle this call to reject an

        otherwise valid request when the total rate of management read operations exceeds 10 requests per second

        for a given tenancy.

        '
      operationId: ListKeys
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/ProtectionModeQueryParam'
      - $ref: '#/components/parameters/KeyAlgorithmQueryParam'
      - $ref: '#/components/parameters/KeyLengthQueryParam'
      - $ref: '#/components/parameters/KeyCurveQueryParam'
      responses:
        '200':
          description: A list of keys.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then there are additional items still to get. Include this value as the `page` parameter for the

                subsequent GET request. For information about pagination, see

                [List Pagination](/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                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.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/KeySummary'
                type: array
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Lists keys in the specified vault and compartment.
      tags:
      - kmsManagement
      x-example: 'GET /20180608/keys?compartmentId=<var>&lt;compartmentId&gt;</var>

        Host: <var>&lt;managementEndpoint&gt;</var>

        <var>&lt;authorization and other headers&gt;</var>

        '
    post:
      description: 'Creates a new master encryption key.


        As a management operation, this call is subject to a Key Management limit that applies to the total

        number of requests across all management write operations. Key Management might throttle this call

        to reject an otherwise valid request when the total rate of management write operations exceeds 10

        requests per second for a given tenancy.

        '
      operationId: CreateKey
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '200':
          description: The key is being created.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                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.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Key'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Creates a new key.
      tags:
      - kmsManagement
      x-example: "POST /20180608/keys\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea\",\n  \"displayName\": \"Key C\",\n  \"keyShape\": {\n    \"algorithm\": \"AES\",\n    \"length\": 16\n  }\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateKeyDetails'
        description: CreateKeyDetails
        required: true
  /20180608/keys/actions/restoreFromFile:
    post:
      description: 'Restores the specified key to the specified vault, based on information in the backup file provided.

        If the vault doesn''t exist, the operation returns a response with a 404 HTTP status error code. You

        need to first restore the vault associated with the key.

        '
      operationId: RestoreKeyFromFile
      parameters:
      - $ref: '#/components/parameters/ContentLengthHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/OptionalContentMD5Header'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RestoreKeyFromFileDetails'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '202':
          description: The key restore operation started successfully.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-content-md5:
              description: 'The base64-encoded MD5 hash value of the request body, as computed

                by the server.

                '
              schema:
                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.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the work request, used to track the progress of the

                restore operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Key'
        '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/DefaultError'
      summary: Restores a key to a vault from a file.
      tags:
      - kmsManagement
      x-example: "POST /20180608/keys/actions/restoreFromFile\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"RestoreKeyFromFileDetails\" : \"key backup bytes..\"\n}\n"
      x-related-resource: '#/definitions/Key'
  /20180608/keys/actions/restoreFromObjectStore:
    post:
      description: 'Restores the specified key to the specified vault from an Oracle Cloud Infrastructure

        Object Storage location. If the vault doesn''t exist, the operation returns a response with a

        404 HTTP status error code. You need to first restore the vault associated with the key.

        '
      operationId: RestoreKeyFromObjectStore
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '202':
          description: The key restore operation started successfully.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                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.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the work request, used to track the progress of the

                restore operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Key'
        '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/DefaultError'
      summary: Restores a key to a vault from an object storage location.
      tags:
      - kmsManagement
      x-example: "POST /20180608/keys/actions/restoreFromObjectStore\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n\"RestoreKeyFromObjectStoreDetails\" : {\n    \"backupLocation\" : {\n      \"BackupLocationURI\" : {\n        \"uri\" : \"http://n/namespace/b/bucket/o/object\"\n      }\n    }\n}\n"
      x-related-resource: '#/definitions/Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreKeyFromObjectStoreDetails'
        description: Location to restore the backup from
  /20180608/keys/import:
    post:
      description: "Imports AES and RSA keys to create a new key. The key material must be base64-encoded \nand wrapped by the vault's public RSA wrapping key before you can import it. \nKey Management supports both RSA and AES keys. The AES keys are symmetric keys \nof length 128 bits (16 bytes), 192 bits (24 bytes), or 256 bits (32 bytes), and the RSA keys are asymmetric keys of length 2048 bits (256 bytes), 3072 bits (384 bytes), and 4096 bits (512 bytes). \nFurthermore, the key length must match what you specify at the time of import. When importing an asymmetric key, \nonly private key must be wrapped in PKCS8 format while the corresponding public key is generated internally by KMS.\n"
      operationId: ImportKey
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '200':
          description: The key is being imported and is in the `CREATING` state. After the key is imported, it is set to the `ENABLED` state.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                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.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Key'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Imports the given wrapped AES key.
      tags:
      - kmsManagement
      x-example: "POST /20180608/keys/import\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea\",\n  \"displayName\": \"Key C\",\n  \"keyShape\": {\n    \"algorithm\": \"AES\",\n    \"length\": 16\n  },\n  \"wrappedImportKey\":{\n     \"wrappingAlgorithm\": \"RSA_OAEP_SHA256\",\n     \"keyMaterial\": \"089d08927390280802d0987c09e7798h09f879870909c098709a709870970987b09709870c987098d70e==\"\n   },\n  \"protectionMode\":\"HSM\"\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportKeyDetails'
        description: ImportKeyDetails
        required: true
  /20180608/keys/{keyId}:
    get:
      description: 'Gets information about the specified master encryption key.


        As a management operation, this call is subject to a Key Management limit that applies to the total number

        of requests across all management read operations. Key Management might throttle this call to reject an

        otherwise valid request when the total rate of management read operations exceeds 10 requests per second for

        a given tenancy.

        '
      operationId: GetKey
      parameters:
      - $ref: '#/components/parameters/KeyIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        '200':
          description: The specified key.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                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.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Key'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Gets details about a key.
      tags:
      - kmsManagement
      x-example: 'GET /20180608/keys/<var>&lt;key_OCID&gt;</var>

        Host: <var>&lt;managementEndpoint&gt;</var>

        <var>&lt;authorization and other headers&gt;</var>

        '
    put:
      description: 'Updates the properties of a master encryption key. Specifically, you can update the

        `displayName`, `freeformTags`, and `definedTags` properties. Furthermore,

        the key must be in an `ENABLED` or `CREATING` state to be updated.


        As a management operation, this call is subject to a Key Management limit that applies to the total number

        of requests across all management write operations. Key Management might throttle this call to reject an

        otherwise valid request when the total rate of management write operations exceeds 10 requests per second

        for a given tenancy.

        '
      operationId: UpdateKey
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/KeyIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        '200':
          description: The key is being updated according to the request.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                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.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Key'
        '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/DefaultError'
      summary: Updates a key's properties.
      tags:
      - kmsManagement
      x-example: "PUT /20180608/keys/<var>&lt;key_OCID&gt;</var>\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"Key CC\"\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateKeyDetails'
        description: UpdateKeyDetails
        required: true
  /20180608/keys/{keyId}/actions/backup:
    post:
      description: 'Backs up an encrypted file that contains all key versions and metadata of the specified key so that you can restore

        the key later. The file also contains the metadata of the vault that the key belonged to.

        '
      operationId: BackupKey
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/KeyIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '202':
          description: The key backup operation started successfully.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                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.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the work request, used to track the progress of the

                backup operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Key'
        '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/DefaultError'
      summary: Backs up the key and associated key metadata.
      tags:
      - kmsManagement
      x-example: "POST /20180608/keys/<var>&lt;key_OCID&gt;</var>/actions/backup\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"BackupKeyDetails\": {\n      \"backupLocation\" : {\n          \"BackupLocationURI\" : {\n            \"uri\" : \"http://n/namespace/b/bucket/o/object\"\n          }\n      }\n  }\n}\n"
      x-related-resource: '#/definitions/Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupKeyDetails'
        description: BackupKeyDetails
  /20180608/keys/{keyId}/actions/cancelDeletion:
    post:
      description: 'Cancels the scheduled deletion of the specified key. Canceling

        a scheduled deletion restores the key''s lifecycle state to what

        it was before its scheduled deletion.


        As a provisioning operation, this call is subject to a Key Management limit that applies to

        the total number of requests across all provisioning write operations. Key Management might

        throttle this call to reject an otherwise valid request when the total rate of provisioning

        write operations exceeds 10 requests per second for a given tenancy.

        '
      operationId: CancelKeyDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/KeyIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '200':
          description: The key's scheduled deletion has been canceled.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                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.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Key'
        '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/DefaultError'
      summary: Cancels the scheduled deletion of a key.
      tags:
      - kmsManagement
      x-example: 'POST /20180608/keys/<var>&lt;key_OCID&gt;</var>/actions/cancelDeletion

        Host: <var>&lt;managementEndpoint&gt;</var>

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Key'
  /20180608/keys/{keyId}/actions/changeCompartment:
    post:
      description: 'Moves a key into a different compartment within the same tenancy. For information about

        moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).


        When provided, if-match is checked against the ETag values of the key.


        As a provisioning operation, this call is subject to a Key Management limit that applies to

        the total number of requests across all provisioning write operations. Key Management might

        throttle this call to reject an otherwise valid request when the total rate of provisioning

        write operations exceeds 10 requests per second for a given tenancy.

        '
      operationId: ChangeKeyCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/KeyIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '204':
          description: The compartment information for the key has been updated.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                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.

                '
              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/DefaultError'
      summary: Moves a key into a different compartment.
      tags:
      - kmsManagement
      x-example: "POST /20180608/keys/<var>&lt;key_OCID&gt;</var>/actions/changeCompartment\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea\",\n}\n"
      x-related-resource: '#/definitions/Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeKeyCompartmentDetails'
        description: Details of change key compartment.
        required: true
  /20180608/keys/{keyId}/actions/disable:
    post:
      description: 'Disables a master encryption key so it can no longer be used for encryption, decryption, or

        generating new data encryption keys.


        As a management operation, this call is subject to a Key Management limit that applies to the total number

        of requests across all management write operations. Key Management might throttle this call to reject an

        otherwise valid request when the total rate of management write operations exceeds 10 requests per second

        for a given tenancy.

        '
      operationId: DisableKey
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/KeyIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '200':
          description: The key is being disabled.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                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.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Key'
        '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/DefaultError'
      summary: Disables a key so it cannot be used for cryptographic operations.
      tags:
      - kmsManagement
      x-example: 'POST /20180608/keys/<var>&lt;key_OCID&gt;</var>/actions/disable

        Host: <var>&lt;managementEndpoint&gt;</var>

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Key'
  /20180608/keys/{keyId}/actions/enable:
    post:
      description: 'Enables a master encryption key so it can be used for encryption, decryption, or

        generating new data encryption keys.


        As a management operation, this call is subject to a Key Management limit that applies to the total number

        of requests across all management write operations. Key Management might throttle this call to reject an

        otherwise valid request when the total rate of management write operations exceeds 10 requests per second

        for a given tenancy.

        '
      operationId: EnableKey
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/KeyIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '200':
          description: The key is being enabled.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                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.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Key'
        '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/DefaultError'
      summary: Enables a key so it can be used for cryptographic operations.
      tags:
      - kmsManagement
      x-example: 'POST /20180608/keys/<var>&lt;key_OCID&gt;</var>/actions/enable

        Host: <var>&lt;managementEndpoint&gt;</var>

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Key'
  /20180608/keys/{keyId}/actions/scheduleDeletion:
    post:
      description: 'Schedules the deletion of the specified key. This sets the lifecycle state of the key

        to `PENDING_DELETION` and then deletes it after the specified retention period ends.


        As a provisioning operation, this call is subject to a Key Management limit that applies to

        the total number of requests across all provisioning write operations. Key Management might

        throttle this call to reject an otherwise valid request when the total rate of provisioning

        write operations exceeds 10 requests per second for a given tenancy.

        '
      operationId: ScheduleKeyDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/compo

# --- truncated at 32 KB (106 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-kmsmanagement-api-openapi.yml