IBM Key Protect API

Introduction IBM® Key Protect for IBM Cloud® helps you provision encrypted keys for apps across IBM Cloud. As you manage the lifecycle of your keys, you can benefit from knowing that your keys are secured by cloud-based FIPS 140-2 Level 3 hardware security modules HSMs that protect against the theft of information. Key Protect provides a REST API that you can use with any programming language to store, retrieve, and generate encryption keys. For details about using Key Protect, see the IBM Cloud docshttps://cloud.ibm.com/docs/key-protect/. API endpoint bash https://

MethodPathSummary
POST/api/v2/keysCreate a key
GET/api/v2/keysList keys
HEAD/api/v2/keysRetrieve key total
POST/api/v2/keys_with_policy_overridesCreate a key with policy overrides
GET/api/v2/keys/{id}Retrieve a key
POST/api/v2/keys/{id}Invoke an action on a key
PATCH/api/v2/keys/{id}Update (patch) a key
DELETE/api/v2/keys/{id}Delete a key
GET/api/v2/keys/{id}/metadataRetrieve key metadata
DELETE/api/v2/keys/{id}/purgePurge a deleted key
POST/api/v2/keys/{id}/restoreRestore a key
GET/api/v2/keys/{id}/versionsList key versions
POST/api/v2/keys/{id}/actions/wrapWrap a key
POST/api/v2/keys/{id}/actions/unwrapUnwrap a key
POST/api/v2/keys/{id}/actions/rewrapRewrap a key
POST/api/v2/keys/{id}/actions/rotateRotate a key
POST/api/v2/keys/{id}/actions/setKeyForDeletionSet a key for deletion
POST/api/v2/keys/{id}/actions/unsetKeyForDeletionUnset a key for deletion
POST/api/v2/keys/{id}/actions/enableEnable a key
POST/api/v2/keys/{id}/actions/disableDisable a key
POST/api/v2/keys/{id}/actions/syncSync associated resources
PUT/api/v2/keys/{id}/policiesSet key policies
GET/api/v2/keys/{id}/policiesList key policies
PUT/api/v2/instance/policiesSet instance policies
GET/api/v2/instance/policiesList instance policies
GET/api/v2/instance/allowed_ip_portRetrieve allowed IP port
POST/api/v2/import_tokenCreate an import token
GET/api/v2/import_tokenRetrieve an import token
GET/api/v2/keys/{id}/registrationsList registrations for a key
GET/api/v2/keys/registrationsList registrations for any key
POST/api/v2/keys/{id}/aliases/{alias}Create an alias
DELETE/api/v2/keys/{id}/aliases/{alias}Delete an alias
GET/api/v2/key_ringsList key rings
POST/api/v2/key_rings/{key-ring-id}Create a key ring
DELETE/api/v2/key_rings/{key-ring-id}Delete key ring
GET/api/v2/kmip_adaptersList KMIP Adapters
POST/api/v2/kmip_adaptersCreate a KMIP Adapter
GET/api/v2/kmip_adapters/{id}Retrieve a KMIP Adapter
DELETE/api/v2/kmip_adapters/{id}Delete a KMIP Adapter
GET/api/v2/kmip_adapters/{adapter_id}/kmip_objectsList KMIP objects of a KMIP Adapter
GET/api/v2/kmip_adapters/{adapter_id}/kmip_objects/{id}Retrieve a KMIP object from a KMIP Adapter
DELETE/api/v2/kmip_adapters/{adapter_id}/kmip_objects/{id}Delete a KMIP object from a KMIP Adapter
GET/api/v2/kmip_adapters/{adapter_id}/certificatesList client certificates of a KMIP Adapter
POST/api/v2/kmip_adapters/{adapter_id}/certificatesAdd a client certificate to a KMIP Adapter
GET/api/v2/kmip_adapters/{adapter_id}/certificates/{id}Retrieve a client certificate from a KMIP Adapter
DELETE/api/v2/kmip_adapters/{adapter_id}/certificates/{id}Delete a client certificate from a KMIP Adapter