{ "opencollection": "1.0.0", "info": { "name": "Vault Secret Retrieval Secrets API", "version": "20190301" }, "items": [ { "info": { "name": "secrets", "type": "folder" }, "items": [ { "info": { "name": "Gets a secret bundle by secret name and vault ID.", "type": "http" }, "http": { "method": "POST", "url": "https://secrets.vaults.$region.oci.oraclecloud.com/20190301/secretbundles/actions/getByName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "secretName", "value": "", "type": "query", "description": "A user-friendly name for the secret. Secret names are unique within a vault. Secret names are case-sensitive." }, { "name": "vaultId", "value": "", "type": "query", "description": "The OCID of the vault that contains the secret." }, { "name": "versionNumber", "value": "", "type": "query", "description": "The version number of the secret." }, { "name": "secretVersionName", "value": "", "type": "query", "description": "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.)" }, { "name": "stage", "value": "", "type": "query", "description": "The rotation state of the secret version." } ] }, "docs": "Gets a secret bundle by secret name and vault ID, and secret version that matches either the specified `stage`, `secretVersionName`, or `versionNumber` parameter.\nIf none of these parameters are provided, the bundle for the secret version marked as `CURRENT` is returned.\n" }, { "info": { "name": "Gets a secret bundle.", "type": "http" }, "http": { "method": "GET", "url": "https://secrets.vaults.$region.oci.oraclecloud.com/20190301/secretbundles/:secretId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "secretId", "value": "", "type": "path", "description": "The OCID of the secret." }, { "name": "versionNumber", "value": "", "type": "query", "description": "The version number of the secret." }, { "name": "secretVersionName", "value": "", "type": "query", "description": "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.)" }, { "name": "stage", "value": "", "type": "query", "description": "The rotation state of the secret version." } ] }, "docs": "Gets a secret bundle that matches either the specified `stage`, `secretVersionName`, or `versionNumber` parameter.\nIf none of these parameters are provided, the bundle for the secret version marked as `CURRENT` will be returned.\n" }, { "info": { "name": "Lists all secret bundle versions.", "type": "http" }, "http": { "method": "GET", "url": "https://secrets.vaults.$region.oci.oraclecloud.com/20190301/secretbundles/:secretId/versions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "secretId", "value": "", "type": "path", "description": "The OCID of the secret." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call. For information about pagination, see\n[List Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call. For information about\npagination, see [List Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sort order. The default\norder for `VERSION_NUMBER` is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "docs": "Lists all secret bundle versions for the specified secret." } ] } ], "bundled": true }