How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Kms Hsm Cluster API

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

Oracle Kms Hsm Cluster API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 12 operations across 10 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version release.

Requests are made against a single base URL, /.

12 operations 10 paths 14 schemas 5 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
release
Base URL
https://{host}:{port}/ords/
License
Oracle Corporation
Resource Areas
1

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 5 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

kmsHsmCluster 12
GET
/20180608/hsmClusters
Lists all HSM cluster resources contained within the specified compartment.
ListHsmClusters 6 params → 200400401404429500default
POST
/20180608/hsmClusters
Creates a new HSM cluster resource
CreateHsmCluster 2 params body → 200400401404409412429500
GET
/20180608/hsmClusters/{hsmClusterId}
Gets details about a HSM Cluster resource.
GetHsmCluster 2 params → 200400401404429500default
PUT
/20180608/hsmClusters/{hsmClusterId}
Updates the properties of a HSM Cluster resource.
UpdateHsmCluster 3 params body → 200400401404409412429500
POST
/20180608/hsmClusters/{hsmClusterId}/actions/cancelDeletion
Cancels the scheduled deletion of a HSM Cluster resource.
CancelHsmClusterDeletion 4 params → 200400401404409412429500
POST
/20180608/hsmClusters/{hsmClusterId}/actions/changeCompartment
Moves a HSM Cluster resource into a different compartment.
ChangeHsmClusterCompartment 4 params body → 204400401404409412429500
POST
/20180608/hsmClusters/{hsmClusterId}/actions/downloadCertificateSigningRequest
Download certificate signing request for the HSM Cluster resource.
DownloadCertificateSigningRequest 4 params → 200400401404409412429500
POST
/20180608/hsmClusters/{hsmClusterId}/actions/scheduleDeletion
Schedules the deletion of a HSM Cluster resource.
ScheduleHsmClusterDeletion 4 params body → 200400401404409412429500
POST
/20180608/hsmClusters/{hsmClusterId}/actions/uploadPartitionCertificates
Upload partition certificate and partition owner certificate for the HSM cluster.
UploadPartitionCertificates 4 params body → 200400401404409412429500
GET
/20180608/hsmClusters/{hsmClusterId}/hsmPartitions
Lists all HSM and details for a HSM Cluster resource.
ListHsmPartitions 7 params → 200400401404409429500default
GET
/20180608/hsmClusters/{hsmClusterId}/hsmPartitions/{hsmPartitionId}
Get HSM information for the specific hsmPartitionId.
GetHsmPartition 4 params → 200400401404409429500default
GET
/20180608/hsmClusters/{hsmClusterId}/preCoUserCredentials
Get Pre Crypto Officer User Credentials.
GetPreCoUserCredentials 3 params → 200400401404409429500default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are HsmCluster (10 properties), HsmClusterSummary (10 properties), HsmPartitionSummary (7 properties), HsmPartition (6 properties). Each schema is shown below with its type and property counts.

UpdateHsmClusterDetails
object
The details of the HsmCluster resource that you wish to update.
3 properties
HsmCluster
object
Dedicated KMS-HSM Cluster Management
10 properties 7 required
PreCoUserCredentials
object
Pre Crypto officer user credentials.
2 properties 2 required
HsmClusterSummary
object
An object which encapsulates the details of a given HSM Cluster.
10 properties 7 required
ScheduleHsmClusterDeletionDetails
object
Details for scheduling HSM resource deletion.
1 property
ChangeHsmClusterCompartmentDetails
object
The details of the compartment you wish to move the hsm cluster to.
1 property 1 required
HsmPartition
object
Dedicated KMS-HSM Partition Management
6 properties 6 required
UploadPartitionCertificatesDetails
object
An object that encapsulates the necessary partition certificates.
2 properties 2 required
HsmClusterCollection
object
HsmClusterCollection object with page of HsmClusterSummary objects.
1 property 1 required
Error
object
The desciption of Error message.
2 properties 2 required
HsmPartitionCollection
object
HsmPartitionCollection object with page of HsmPartitionSummary objects. A HsmPartitionSummary object contains details about the corresponding HSM.
1 property 1 required
CreateHsmClusterDetails
object
The details of the HSM cluster resource that you want to create.
4 properties 2 required
PortInformation
object
Details of a single portInformation item include the PortNumber (an integer used as an identifier) and the PortType (this refers to either an enum value of Man…
2 properties 2 required
HsmPartitionSummary
object
An object which encapsulates the details of a given HSM.
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-kmshsmcluster-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from

This is an independent, third-party profile of Oracle Kms Hsm Cluster API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.