Gets a secret bundle by secret name and vault ID.
POST {{baseUrl}}/secretbundles/actions/getByName?secretName=<string>&vaultId=<string>&versionNumber=0&secretVersionName=<string>&stage=PENDING
Gets a secret bundle by secret name and vault ID, and secret version that matches either the specified stage
, secretVersionName
, or versionNumber
parameter.
If none of these parameters are provided, the bundle for the secret version marked as CURRENT
is returned.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
secretName | string | (Required) A user-friendly name for the secret. Secret names are unique within a vault. Secret names are case-sensitive. | |
vaultId | string | (Required) The OCID of the vault that contains the secret. | |
versionNumber | number | The version number of the secret. | |
secretVersionName | string | The name of the secret. (This might be referred to as the name of the secret version. Names are unique across the different versions of a secret.) | |
stage | string | The rotation state of the secret version. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
opc-request-id | string | Unique identifier for the request. | |
Accept | string |
RESPONSES
status: OK
{"secretId":"\u003cstring\u003e","versionNumber":"\u003clong\u003e","metadata":{"anim3":{}},"secretBundleContent":{"contentType":"BASE64"},"stages":["CURRENT","DEPRECATED"],"timeCreated":"\u003cdateTime\u003e","timeOfDeletion":"\u003cdateTime\u003e","timeOfExpiry":"\u003cdateTime\u003e","versionName":"\u003cstring\u003e"}