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 Management API

The kmsManagement API from Oracle — 18 operation(s) for kmsmanagement.

Oracle Kms Management 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 21 operations across 18 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version release.

Requests are made against a single base URL, /.

21 operations 18 paths 26 schemas 6 GET14 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 21

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

kmsManagement 21
GET
/20180608/keys
Lists keys in the specified vault and compartment.
ListKeys 10 params → 200400401404429500default
POST
/20180608/keys
Creates a new key.
CreateKey 2 params body → 200400401404409429500default
POST
/20180608/keys/actions/restoreFromFile
Restores a key to a vault from a file.
RestoreKeyFromFile 6 params → 202400401404409412429500
POST
/20180608/keys/actions/restoreFromObjectStore
Restores a key to a vault from an object storage location.
RestoreKeyFromObjectStore 3 params body → 202400401404409412429500
POST
/20180608/keys/import
Imports the given wrapped AES key.
ImportKey 2 params body → 200400401404409429500default
GET
/20180608/keys/{keyId}
Gets details about a key.
GetKey 2 params → 200400401404429500default
PUT
/20180608/keys/{keyId}
Updates a key's properties.
UpdateKey 3 params body → 200400401404409412429500
POST
/20180608/keys/{keyId}/actions/backup
Backs up the key and associated key metadata.
BackupKey 4 params body → 202400401404409412429500
POST
/20180608/keys/{keyId}/actions/cancelDeletion
Cancels the scheduled deletion of a key.
CancelKeyDeletion 4 params → 200400401404409412429500
POST
/20180608/keys/{keyId}/actions/changeCompartment
Moves a key into a different compartment.
ChangeKeyCompartment 4 params body → 204400401404409412429500
POST
/20180608/keys/{keyId}/actions/disable
Disables a key so it cannot be used for cryptographic operations.
DisableKey 4 params → 200400401404409412429500
POST
/20180608/keys/{keyId}/actions/enable
Enables a key so it can be used for cryptographic operations.
EnableKey 4 params → 200400401404409412429500
POST
/20180608/keys/{keyId}/actions/scheduleDeletion
Schedules the deletion of a key.
ScheduleKeyDeletion 4 params body → 200400401404409412429500
GET
/20180608/keys/{keyId}/keyVersions
Lists all key versions for a key.
ListKeyVersions 6 params → 200400401404429500default
POST
/20180608/keys/{keyId}/keyVersions
Creates a new key version resource and rotates the key to use it for encryption.
CreateKeyVersion 3 params body → 200400401404409429500default
POST
/20180608/keys/{keyId}/keyVersions/import
Imports the given wrapped key material and then rotate the key to begin using the new key version for the specified key.
ImportKeyVersion 3 params body → 200400401404409429500default
GET
/20180608/keys/{keyId}/keyVersions/{keyVersionId}
Gets details about a key version.
GetKeyVersion 3 params → 200400401404429500default
POST
/20180608/keys/{keyId}/keyVersions/{keyVersionId}/actions/cancelDeletion
Cancels the scheduled deletion of a key version.
CancelKeyVersionDeletion 5 params → 200400401404409412429500
POST
/20180608/keys/{keyId}/keyVersions/{keyVersionId}/actions/scheduleDeletion
Schedules the deletion of a key version.
ScheduleKeyVersionDeletion 5 params body → 200400401404409412429500
GET
/20180608/replicaOperations/{replicationId}/status
Gets the replication status of a replica operation
GetReplicationStatus 2 params → 200400401404429500default
GET
/20180608/wrappingKeys
Gets details about the RSA wrapping key associated with the vault.
GetWrappingKey 1 param → 200400401404429500default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are Key (18 properties), KeyVersion (14 properties), KeySummary (12 properties), KeyVersionSummary (10 properties). Each schema is shown below with its type and property counts.

UpdateKeyDetails
object
The details of the Key that you wish to update.
5 properties
Key
object
The logical entities that represent one or more key versions, each of which contains cryptographic material.
18 properties 8 required
KeySummary
object
The details of the Key.
12 properties 6 required
KeyVersionSummary
object
The details of the KeyVersion.
10 properties 6 required
ImportKeyDetails
object
The details of the Key that you wish to import.
9 properties 4 required
ReplicationStatusDetails
object
Details of replication status across all replica regions
1 property
RestoreKeyFromObjectStoreDetails
object
The details of the backup location from which you want to restore the Key.
1 property
CreateKeyDetails
object
The details of the key that you want to create.
9 properties 3 required
AutoKeyRotationDetails
object
The details of auto rotation schedule for the Key being create updated or imported.
6 properties
ChangeKeyCompartmentDetails
object
The deatils of the compartment that you wish to move the Key.
1 property 1 required
KeyShape
object
The cryptographic properties of a key.
3 properties 2 required
ScheduleKeyDeletionDetails
object
Details for scheduling key deletion.
1 property
ExternalKeyVersionReference
object
A reference to key version on external key manager.
1 property
BackupKeyDetails
object
The details of the Key that you wish to backup.
1 property
KeyReplicaDetails
object
Key replica details
1 property
Error
object
The desciption of Error message.
2 properties 2 required
WrappedImportKey
object
The details of the wrapped import Key.
2 properties 2 required
ImportKeyVersionDetails
object
The details of the KeyVersion that you wish to import.
3 properties 1 required
BackupLocation
object
Backup upload location
1 property 1 required
KeyVersionReplicaDetails
object
KeyVersion replica details
1 property
ExternalKeyReferenceDetails
object
Key reference data to be returned to the customer as a response.
2 properties 2 required
ScheduleKeyVersionDeletionDetails
object
Details for scheduling key version deletion.
1 property
ReplicaDetails
object
Details of replication status
2 properties
KeyVersion
object
The details of the KeyVersion associated with the Key.
14 properties 5 required
WrappingKey
object
The public RSA wrapping key associated with the vault
6 properties 6 required
ExternalKeyReference
object
A reference to the key on external key manager.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-kmsmanagement-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 Management 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.