Events for Vaults, Keys, and Secrets
Learn about Key Management event notifications for success and failure scenarios.
For information on how to create automation using OCI events, see OCI Events.
Vault Event Types
| Friendly Name | Event Type |
|---|---|
| Backup Vault Begin |
|
| Backup Vault End |
|
| Cancel Vault Deletion Begin |
|
| Cancel Vault Deletion End |
|
| Change Vault Compartment Begin |
|
| Change Vault Compartment End |
|
| Create Vault Begin |
|
| Create Vault End |
|
| Create Vault Replica Begin |
|
| Create Vault Replica End |
|
| Delete Vault Replica Begin |
|
| Delete Vault Replica End |
|
| Restore Vault Begin |
|
| Restore Vault End |
|
| Schedule Vault Deletion Begin |
|
| Schedule Vault Deletion End |
|
Vault Example
This is a reference event for vaults:
{
"eventType" : "com.oraclecloud.keymanagementservice.createvault.end",
"cloudEventsVersion" : "0.1",
"eventTypeVersion" : "2.0",
"source" : "KeyManagementService",
"eventTime" : "2025-02-25T17:41:22Z",
"contentType" : "application/json",
"data" : {
"compartmentId" : "ocid1.tenancy.oc1..<unique_ID>",
"compartmentName" : "example_name",
"resourceName" : "my_vault",
"resourceId" : "ocid1.vault.oc1.iad.<unique_ID>",
"availabilityDomain" : "AD3",
"additionalDetails": {
"lsn": "14",
"state" : "CREATED",
"lastModifiedTimestamp" : 1746008782950
},
"eventID" : "<unique_ID>",
"extensions" : {
"compartmentId" : "ocid1.tenancy.oc1..<unique_ID>"
}
}Key Event Types
| Friendly Name | Event Type |
|---|---|
| Auto Key Rotate Begin |
|
| Auto Key Rotate End |
|
| Cancel Key Deletion Begin |
|
| Cancel Key Deletion End |
|
| Cancel Key Version Deletion Begin |
|
| Cancel Key Version Deletion End |
|
| Change Key Compartment Begin |
|
| Change Key Compartment End |
|
| Create Key Begin |
|
| Create Key End |
|
| Create Key Version Begin |
|
| Create Key Version End |
|
| Disable Key Begin |
|
| Disable Key End |
|
| Enable Key Begin |
|
| Enable Key End |
|
|
Key Version Limit (emitted when key versions capacity reaches 80%) |
|
| Schedule Key Deletion Begin |
|
| Schedule Key Deletion End |
|
| Schedule Key Version Deletion Begin |
|
| Schedule Key Version Deletion End |
|
Key Example
This is a reference event for keys:
{
"eventType": "com.oraclecloud.keymanagementservice.createkey.end",
"cloudEventsVersion": "0.1",
"eventTypeVersion": "2.0",
"source": "KeyManagementService",
"eventTime": "2019-08-01T15:44:31.792Z",
"contentType": "application/json",
"data": {
"compartmentId": "ocid1.compartment.oc1..<unique_ID>",
"compartmentName": "KMSCanaryPhoenix",
"resourceName": "my_key<unique_ID>",
"resourceId": "ocid1.key.oc1.phx.<unique_ID>",
"availabilityDomain": "AD2",
"additionalDetails": {
"vaultId": "ocid1.vault.oc1.iad.<unique_ID>",
"lsn": 4,
"state": "CREATED",
"lastModifiedTimestamp": 1746008711128},
}
"eventID": "<unique_ID>",
"extensions": {
"compartmentId": "ocid1.compartment.oc1..<unique_ID>"
}
}Key Version Example
This is a reference event for key versions:
{
"eventType": "com.oraclecloud.keymanagementservice.createkeyversion.end",
"cloudEventsVersion": "0.1",
"eventTypeVersion": "2.0",
"source": "KeyManagementService",
"eventTime": "2019-08-01T15:44:31.792Z",
"contentType": "application/json",
"data": {
"compartmentId": "ocid1.compartment.oc1..<unique_ID>",
"compartmentName": "KMSCanaryPhoenix",
"resourceName": "my_key<unique_ID>",
"resourceId": "ocid1.key.oc1.phx.<unique_ID>",
"availabilityDomain": "AD2",
"additionalDetails": {
"vaultId": "ocid1.vault.oc1.iad.<unique_ID>",
"keyversionId": "ocid1.keyversion.oc1.iad.<unique_ID>",
"lsn": 4,
"keyId": "ocid1.key.oc1.iad.<unique_ID>",
"state": "ENABLED",
"lastModifiedTimestamp": 1746008711128},
}
"eventID": "<unique_ID>",
"extensions": {
"compartmentId": "ocid1.compartment.oc1..<unique_ID>"
}
}