{ "opencollection": "1.0.0", "info": { "name": "Vault Key Management Kms Vault API", "version": "release" }, "items": [ { "info": { "name": "KmsVault", "type": "folder" }, "items": [ { "info": { "name": "Restores a vault from an encrypted backup file.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/vaults/actions/restoreFromFile", "headers": [ { "name": "content-length", "value": "" }, { "name": "if-match", "value": "" }, { "name": "content-md5", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." } ] }, "docs": "Restores a vault from an encrypted backup file. If a vault\nwith the same OCID already exists, this operation returns a response with a\n409 HTTP status error code.\n" }, { "info": { "name": "Restores a vault from an object storage location.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/vaults/actions/restoreFromObjectStore", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restores a vault from an encrypted backup file stored in Oracle Cloud Infrastructure Object\nStorage. If a vault with the same OCID already exists, this operation returns\na response with a 409 HTTP status error code.\n" }, { "info": { "name": "Backs up a vault.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/vaults/:vaultId/actions/backup", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vaultId", "value": "", "type": "path", "description": "The OCID of the vault." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later.\nYou can backup a vault whether or not it contains keys. This operation only backs up the\nmetadata of the vault, and does not include key metadata.\n" }, { "info": { "name": "Gets the specified vault's usage against service limits.", "type": "http" }, "http": { "method": "GET", "url": "/20180608/vaults/:vaultId/usage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vaultId", "value": "", "type": "path", "description": "The OCID of the vault." } ] }, "docs": "Gets the count of keys and key versions in the specified vault to calculate usage against service limits.\n" }, { "info": { "name": "Lists vaults in the compartment.", "type": "http" }, "http": { "method": "GET", "url": "/20180608/vaults", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "docs": "Lists the vaults in the specified compartment.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning read operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nread operations exceeds 10 requests per second for a given tenancy.\n" }, { "info": { "name": "Creates a new vault.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/vaults", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new vault. The type of vault you create determines key placement, pricing, and\navailable options. Options include storage isolation, a dedicated service endpoint instead\nof a shared service endpoint for API calls, and either a dedicated hardware security module\n(HSM) or a multitenant HSM.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this c" }, { "info": { "name": "Gets details about a vault.", "type": "http" }, "http": { "method": "GET", "url": "/20180608/vaults/:vaultId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vaultId", "value": "", "type": "path", "description": "The OCID of the vault." } ] }, "docs": "Gets the specified vault's configuration information.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning read operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nread operations exceeds 10 requests per second for a given tenancy.\n" }, { "info": { "name": "Updates the properties of a vault.", "type": "http" }, "http": { "method": "PUT", "url": "/20180608/vaults/:vaultId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vaultId", "value": "", "type": "path", "description": "The OCID of the vault." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of a vault. Specifically, you can update the\n`displayName`, `freeformTags`, and `definedTags` properties. Furthermore,\nthe vault must be in an ACTIVE or CREATING state to be updated.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations " }, { "info": { "name": "Cancels the scheduled deletion of a vault.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/vaults/:vaultId/actions/cancelDeletion", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vaultId", "value": "", "type": "path", "description": "The OCID of the vault." } ] }, "docs": "Cancels the scheduled deletion of the specified vault. Canceling a scheduled deletion\nrestores the vault and all keys in it to their respective states from before their\nscheduled deletion. All keys that were scheduled for deletion prior to vault\ndeletion retain their lifecycle state and time of deletion.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle " }, { "info": { "name": "Moves a vault into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/vaults/:vaultId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vaultId", "value": "", "type": "path", "description": "The OCID of the vault." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a vault into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen provided, if-match is checked against the ETag values of the resource.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management m" }, { "info": { "name": "Creates a replica for the vault in another region in the same realm", "type": "http" }, "http": { "method": "POST", "url": "/20180608/vaults/:vaultId/actions/createReplica", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vaultId", "value": "", "type": "path", "description": "The OCID of the vault." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a replica for the vault in another region in the same realm\n\nThe API is a no-op if called for same region that a vault is already replicated to.\n409 if called on a vault that is already replicated to a different region. Users need to delete\nexisting replica first before calling it with a different region.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\n" }, { "info": { "name": "Deletes a vault replica", "type": "http" }, "http": { "method": "POST", "url": "/20180608/vaults/:vaultId/actions/deleteReplica", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vaultId", "value": "", "type": "path", "description": "The OCID of the vault." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a vault replica\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n" }, { "info": { "name": "Lists the replicas for a vault", "type": "http" }, "http": { "method": "GET", "url": "/20180608/vaults/:vaultId/actions/listReplicas", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "vaultId", "value": "", "type": "path", "description": "The OCID of the vault." } ] }, "docs": "Lists the replicas for a vault\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n" }, { "info": { "name": "Schedules the deletion of a vault.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/vaults/:vaultId/actions/scheduleDeletion", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vaultId", "value": "", "type": "path", "description": "The OCID of the vault." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Schedules the deletion of the specified vault. This sets the lifecycle state of the vault and all keys in it\nthat are not already scheduled for deletion to `PENDING_DELETION` and then deletes them after the\nretention period ends. The lifecycle state and time of deletion for keys already scheduled for deletion won't\nchange. If any keys in the vault are scheduled to be deleted after the specified time of\ndeletion for the vault, the call is rejected with the error code 409.\n\nAs a provisioning opera" } ] } ], "bundled": true }