Oracle

Oracle Kms Hsm Cluster API

The kmsHsmCluster API from Oracle — 10 operation(s) for kmshsmcluster.

Documentation GitHub OpenAPI

Operations 12

GET /20180608/hsmClusters Lists all HSM cluster resources contained within the specified compartment. #

POST /20180608/hsmClusters Creates a new HSM cluster resource #

GET /20180608/hsmClusters/{hsmClusterId} Gets details about a HSM Cluster resource. #

PUT /20180608/hsmClusters/{hsmClusterId} Updates the properties of a HSM Cluster resource. #

POST /20180608/hsmClusters/{hsmClusterId}/actions/cancelDeletion Cancels the scheduled deletion of a HSM Cluster resource. #

POST /20180608/hsmClusters/{hsmClusterId}/actions/changeCompartment Moves a HSM Cluster resource into a different compartment. #

POST /20180608/hsmClusters/{hsmClusterId}/actions/downloadCertificateSigningRequest Download certificate signing request for the HSM Cluster resource. #

POST /20180608/hsmClusters/{hsmClusterId}/actions/scheduleDeletion Schedules the deletion of a HSM Cluster resource. #

POST /20180608/hsmClusters/{hsmClusterId}/actions/uploadPartitionCertificates Upload partition certificate and partition owner certificate for the HSM cluster. #

GET /20180608/hsmClusters/{hsmClusterId}/hsmPartitions Lists all HSM and details for a HSM Cluster resource. #

GET /20180608/hsmClusters/{hsmClusterId}/hsmPartitions/{hsmPartitionId} Get HSM information for the specific hsmPartitionId. #

GET /20180608/hsmClusters/{hsmClusterId}/preCoUserCredentials Get Pre Crypto Officer User Credentials. #

Documentation

https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/

https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/

https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/

https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/

https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/

https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/

https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/

https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/

https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/

https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/

https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/

https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/

https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/

https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/

https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/

https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/

https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/

https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/

https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/

https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/

https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/

https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/

https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/

https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/

https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/

https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/

https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/

https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/

https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/

https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/

https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/

https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/

https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/

https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/

https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/

https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/

https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/

https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/

https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/

https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/

https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/

https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/

https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/

https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/

https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/

https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/

https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/

https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/

https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/

https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/

https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/

https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/

https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/

https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/

https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/

https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/

https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/

https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/

https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/

https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/

https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/

https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/

https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/

https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/

https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/

https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/

https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/

https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/

https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/

https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/

https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/

https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/

https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/

https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/

https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/

https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/

https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/

https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/

https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/

https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/

https://docs.oracle.com/en-us/iaas/api/#/en/key/release/

https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/

https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/

https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/

https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/

https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/

https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/

https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/

https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/

https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/

https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/

https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/

https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/

https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/

https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/

https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/

https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/

https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/

https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/

https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/

https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/

https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/

https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/

https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/

https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/

https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/

https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/

https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/

https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/

https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/

https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/

https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/

https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/

https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/

https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/

https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/

https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/

https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/

https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/

https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/

https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/

https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/

https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/

https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/

https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/

https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/

https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/

https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/

https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/

https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/

https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/

https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/

https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/

https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/

https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/

https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/

https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/

https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/

https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/

https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/

https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/

https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/

https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/

https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/

https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/

https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/

https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/

https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/

https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/

https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/

https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/

https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/

https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/

https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/

https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/

https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/

https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/

https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/

https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/

https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-kmshsmcluster-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/oracle-kmshsmcluster-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

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 Hsm Cluster 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: kmsHsmCluster
paths:
  /20180608/hsmClusters:
    get:
      description: 'Lists all HSM cluster resources contained within the specified compartment.


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

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

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

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

        '
      operationId: ListHsmClusters
      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'
      responses:
        '200':
          description: A list of HsmCluster resources.
          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:
                $ref: '#/components/schemas/HsmClusterCollection'
        '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 all HSM cluster resources contained within the specified compartment.
      tags:
      - kmsHsmCluster
      x-example: 'GET /20180608/hsmClusters?compartmentId=<var>&lt;compartmentId&gt;</var>

        Host: kms.us-ashburn-1.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/HsmCluster'
    post:
      description: 'Creates a new HSM cluster resource.

        '
      operationId: CreateHsmCluster
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '200':
          description: HsmCluster resource 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/HsmCluster'
        '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: Creates a new HSM cluster resource
      tags:
      - kmsHsmCluster
      x-example: "POST /20180608/hsmClusters\nHost: kms.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5bsdea\",\n  \"displayName\": \"Hsm Cluster 1\"\n}\n"
      x-related-resource: '#/definitions/HsmCluster'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateHsmClusterDetails'
        description: Details for the new HsmCluster resource
        required: true
  /20180608/hsmClusters/{hsmClusterId}:
    get:
      description: 'Retrieves configuration details for the specified HSM Cluster resource.


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

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

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

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

        '
      operationId: GetHsmCluster
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      responses:
        '200':
          description: The specified HSM Cluster resource.
          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/HsmCluster'
        '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 HSM Cluster resource.
      tags:
      - kmsHsmCluster
      x-example: 'GET /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>

        Host: kms.us-ashburn-1.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/HsmCluster'
    put:
      description: 'Modifies properties of an HSM cluster resource, including `displayName`, `freeformTags` and `definedTags`.


        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: UpdateHsmCluster
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      responses:
        '200':
          description: The HSM Cluster resource is 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/HsmCluster'
        '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 the properties of a HSM Cluster resource.
      tags:
      - kmsHsmCluster
      x-example: "PUT /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>\nHost: kms.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"Hsm 1\"\n}\n"
      x-related-resource: '#/definitions/HsmCluster'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateHsmClusterDetails'
        description: Details of the HsmCluster Resource
        required: true
  /20180608/hsmClusters/{hsmClusterId}/actions/cancelDeletion:
    post:
      description: Cancels deletion of specified HSM Cluster, restores it and associated HSM partitions to pre-deletion states.
      operationId: CancelHsmClusterDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      responses:
        '200':
          description: The HSM Cluster resource's scheduled deletion is cancelled 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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HsmCluster'
        '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 HSM Cluster resource.
      tags:
      - kmsHsmCluster
      x-example: "POST /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>/actions/cancelDeletion\nHost: kms.us-ashburn-1.oraclecloud.com \n<var>&lt;authorization and other headers&gt;</var>\n"
      x-related-resource: '#/definitions/HsmCluster'
  /20180608/hsmClusters/{hsmClusterId}/actions/changeCompartment:
    post:
      description: 'Moves a HSM Cluster resource to a different compartment within the same tenancy.

        '
      operationId: ChangeHsmClusterCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '204':
          description: The compartment information for the HSM Cluster resource 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 HSM Cluster resource  into a different compartment.
      tags:
      - kmsHsmCluster
      x-example: "POST /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>/actions/changeCompartment\nHost: kms.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea\",\n}\n"
      x-related-resource: '#/definitions/HsmCluster'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeHsmClusterCompartmentDetails'
        description: Details of change HSM Cluster compartment.
        required: true
  /20180608/hsmClusters/{hsmClusterId}/actions/downloadCertificateSigningRequest:
    post:
      description: 'Retrieves the certificate signing request for the designated HSM Cluster resource.

        '
      operationId: DownloadCertificateSigningRequest
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      responses:
        '200':
          description: The request is processed successfully. The CSR will be returned in the body of the response.
          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:
                maxLength: 5000
                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: Download certificate signing request for the HSM Cluster resource.
      tags:
      - kmsHsmCluster
      x-example: "GET /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>/actions/downloadCertificateSigningRequest\n       Host: kms.us-ashburn-1.oraclecloud.com\n       <var>&lt;authorization and other headers&gt;</var>\n"
      x-related-resource: '#/definitions/HsmCluster'
  /20180608/hsmClusters/{hsmClusterId}/actions/scheduleDeletion:
    post:
      description: "Schedules HSM cluster for deletion, update its lifecycle state to 'PENDING_DELETION' \nand deletes it after the retention period.\n"
      operationId: ScheduleHsmClusterDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      responses:
        '200':
          description: The HSM Cluster resource is scheduled for deletion.
          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/HsmCluster'
        '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: Schedules the deletion of a HSM Cluster resource.
      tags:
      - kmsHsmCluster
      x-example: "POST /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>/actions/scheduleDeletion\nHost: kms.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"timeOfDeletion\": \"2023-04-03T21:10:29.600Z\"\n}\n"
      x-related-resource: '#/definitions/HsmCluster'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleHsmClusterDeletionDetails'
        description: Details of ScheduleHsmClusterDeletionDetails
        required: true
  /20180608/hsmClusters/{hsmClusterId}/actions/uploadPartitionCertificates:
    post:
      description: 'Uploads the partition owner certificates to the HSM Cluster resource.

        '
      operationId: UploadPartitionCertificates
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      responses:
        '200':
          description: Partition certificates uploaded 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
        '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: Upload partition certificate and partition owner certificate for the HSM cluster.
      tags:
      - kmsHsmCluster
      x-example: "POST /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>/actions/uploadPartitionCertificates\n       Host: kms.us-ashburn-1.oraclecloud.com\n       <var>&lt;authorization and other headers&gt;</var>\n"
      x-related-resource: '#/definitions/HsmCluster'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadPartitionCertificatesDetails'
        description: To upload partition certificates.
        required: true
  /20180608/hsmClusters/{hsmClusterId}/hsmPartitions:
    get:
      description: 'Lists all HSM partitions within the specified HSM Cluster resource.

        '
      operationId: ListHsmPartitions
      parameters:
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - description: A filter that returns only resources that match the specified lifecycle state. The state value is case-insensitive.
        in: query
        name: lifecycleState
        required: false
        x-obmcs-enumref: '#/definitions/HsmPartition/lifecycleState'
        schema:
          type: string
      responses:
        '200':
          description: List of HSM summary is returned.
          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:
                $ref: '#/components/schemas/HsmPartitionCollection'
        '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: Lists all HSM and details for a HSM Cluster resource.
      tags:
      - kmsHsmCluster
      x-example: "GET /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>/hsmPartitions\n       Host: kms.us-ashburn-1.oraclecloud.com\n       <var>&lt;authorization and other headers&gt;</var>\n"
      x-related-resource: '#/definitions/HsmPartition'
  /20180608/hsmClusters/{hsmClusterId}/hsmPartitions/{hsmPartitionId}:
    get:
      description: 'Retrieves HSM partition details for the specified HSM cluster.

        '
      operationId: GetHsmPartition
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      - $ref: '#/components/parameters/HsmPartitionIdPathParam'
      responses:
        '200':
          description: The request is processed successfully. HSM information is returned as response.
          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/HsmPartition'
        '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: Get HSM information for the specific hsmPartitionId.
      tags:
      - kmsHsmCluster
      x-example: "GET /20180608/hsmCluster/<var>&lt;hsmClusterId&gt;</var>/hsmPartitions/<var>&lt;hsmPartitionId&gt;</var>/hsmPartitionId\n       Host: kms.us-ashburn-1.oraclecloud.com\n       <var>&lt;authorization and other headers&gt;</var>\n"
      x-related-resource: '#/definitions/HsmPartition'
  /20180608/hsmClusters/{hsmClusterId}/preCoUserCredentials:
    get:
      description: 'Retrieves Pre Crypto Officer user credentials for the specified HSM cluster.

        '
      operationId: GetPreCoUserCredentials
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      responses:
        '200':
          description: The request is processed successfully. The preCo username and password will be returned in the body of the response. Copy credentials for your records will not be shown again.
          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/PreCoUserCredentials'
        '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: Get Pre Crypto Officer User Credentials.
      tags:
      - kmsHsmCluster
      x-example: "GET /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>/preCoUserCredentials\n       Host: kms.us-ashburn-1.oraclecloud.com\n       <var>&lt;authorization and other headers&gt;</var>\n"
      x-related-resource: '#/definitions/HsmCluster'
components:
  schemas:
    UpdateHsmClusterDetails:
      description: The details of the HsmCluster resource that you wish to update.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'An object that represents 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
        displayName:
          description: 'A user-friendly name for the HSM resource. It does not have to be unique, and it is changeable.

            Avoid entering confidential information.

            '
          maxLength: 100
          minLength: 1
          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
      type: object
      x-example: "{\n  \"displayName\": \"Hsm 1\",\n  \"freeformTags\": {\"Department\": \"Finance\"},\n  \"definedTags\":\n  {\n    \"MyFirstNamespace\":\n    {\n      \"CostCenter\": \"SmartAlec\",\n      \"Project\": \"42\",\n      \"CreatedBy\": \"SmartAlec\",\n      \"CreatedDate\": \"9/21/2023T14:00\"\n    },\n    \"Audit\":\n    {\n      \"DataSensitivity\": \"PII\",\n      \"CageSecurity\": \"High\",\n      \"Simplicity\": \"complex\"\n    }\n  }\n}\n"
    HsmCluster:
      description: Dedicated KMS-HSM Cluster Management
      properties:
        compartmentId:
          description: The OCID of the compartment that contains this HSMCluster resource.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'An object that represents 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
        displayName:
          description: 'A user-friendly display name for the HSMCluster resource. It does not have to be unique, and it is changeable.

            Avoid entering confidential information.

            '
          maxLength: 100
          minLength: 1
          type: string
        dnsName:
          description: DNS name for the HSM Cluster -- this will contain information about the region as well.
          maxLength: 255
          minLength: 1
          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
        id:
          description: The OCID of the HSMCluster resource.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'The HSMCluster''s current state.


            Example: `ACTIVE`

            '
          enum:
          - CREATING
          - INITIALIZATION_REQUIRED
          - INITIALIZING
          - ACTIVATION_REQUIRED
          - ACTIVATING
          - ACTIVE
          - DELETING
          - DELETED
          - PENDING_DELETION
          -

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