{ "opencollection": "1.0.0", "info": { "name": "Vault Secret Management Vaults API", "version": "20180608" }, "items": [ { "info": { "name": "vaults", "type": "folder" }, "items": [ { "info": { "name": "Lists all secrets.", "type": "http" }, "http": { "method": "GET", "url": "https://vaults.$region.oci.oraclecloud.com/20180608/secrets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "name", "value": "", "type": "query", "description": "The secret name." }, { "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 order for\n`TIMECREATED` is descending. The default order for `NAME` is ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "vaultId", "value": "", "type": "query", "description": "The OCID of the vault." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter that returns only resources that match the specified lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists all secrets in the specified vault and compartment." }, { "info": { "name": "Creates a secret.", "type": "http" }, "http": { "method": "POST", "url": "https://vaults.$region.oci.oraclecloud.com/20180608/secrets", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new secret according to the details of the request.\n\nThis operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.\n" }, { "info": { "name": "Gets details about a secret.", "type": "http" }, "http": { "method": "GET", "url": "https://vaults.$region.oci.oraclecloud.com/20180608/secrets/:secretId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "secretId", "value": "", "type": "path", "description": "The OCID of the secret." } ] }, "docs": "Gets information about the specified secret." }, { "info": { "name": "Updates a secret's properties.", "type": "http" }, "http": { "method": "PUT", "url": "https://vaults.$region.oci.oraclecloud.com/20180608/secrets/:secretId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "secretId", "value": "", "type": "path", "description": "The OCID of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of a secret. Specifically, you can update the version number of the secret to make\nthat version number the current version. You can also update a secret's description, its free-form or defined tags, rules\nand the secret contents. Updating the secret content automatically creates a new secret version. You cannot, however, update the current secret version number, secret contents, and secret rules at the\nsame time. Furthermore, the secret must in an `ACTIVE` lifecycle state " }, { "info": { "name": "Cancels a scheduled secret deletion.", "type": "http" }, "http": { "method": "POST", "url": "https://vaults.$region.oci.oraclecloud.com/20180608/secrets/:secretId/actions/cancelDeletion", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "secretId", "value": "", "type": "path", "description": "The OCID of the secret." } ] }, "docs": "Cancels the pending deletion of the specified secret. Canceling\na scheduled deletion restores the secret's lifecycle state to what\nit was before you scheduled the secret for deletion.\n" }, { "info": { "name": "Cancels an ongoing secret rotation.", "type": "http" }, "http": { "method": "POST", "url": "https://vaults.$region.oci.oraclecloud.com/20180608/secrets/:secretId/actions/cancelRotation", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "secretId", "value": "", "type": "path", "description": "The OCID of the secret." } ] }, "docs": "Cancels the ongoing secret rotation. The cancellation is contingent on how\nfar the rotation process has progressed. Upon cancelling a rotation, all \nfuture rotations are also disabled.\n" }, { "info": { "name": "Moves a secret into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "https://vaults.$region.oci.oraclecloud.com/20180608/secrets/:secretId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "secretId", "value": "", "type": "path", "description": "The OCID of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a secret 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 secret.\n" }, { "info": { "name": "Rotates an existing secret.", "type": "http" }, "http": { "method": "POST", "url": "https://vaults.$region.oci.oraclecloud.com/20180608/secrets/:secretId/actions/rotate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "secretId", "value": "", "type": "path", "description": "The OCID of the secret." } ] }, "docs": "API to force rotation of an existing secret in Vault and the specified target system; expects secret to have a valid Target System Details object\n" }, { "info": { "name": "Schedules the deletion of a secret.", "type": "http" }, "http": { "method": "POST", "url": "https://vaults.$region.oci.oraclecloud.com/20180608/secrets/:secretId/actions/scheduleDeletion", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "secretId", "value": "", "type": "path", "description": "The OCID of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Schedules the deletion of the specified secret. This sets the lifecycle state of the secret\nto `PENDING_DELETION` and then deletes it after the specified retention period ends.\n" }, { "info": { "name": "Gets details about a secret version.", "type": "http" }, "http": { "method": "GET", "url": "https://vaults.$region.oci.oraclecloud.com/20180608/secrets/:secretId/version/:secretVersionNumber", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "secretId", "value": "", "type": "path", "description": "The OCID of the secret." }, { "name": "secretVersionNumber", "value": "", "type": "path", "description": "The version number of the secret." } ] }, "docs": "Gets information about the specified version of a secret.\n" }, { "info": { "name": "Cancels a scheduled secret version deletion.", "type": "http" }, "http": { "method": "POST", "url": "https://vaults.$region.oci.oraclecloud.com/20180608/secrets/:secretId/version/:secretVersionNumber/actions/cancelDeletion", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "secretId", "value": "", "type": "path", "description": "The OCID of the secret." }, { "name": "secretVersionNumber", "value": "", "type": "path", "description": "The version number of the secret." } ] }, "docs": "Cancels the scheduled deletion of a secret version." }, { "info": { "name": "Schedules a deletion of a secret version.", "type": "http" }, "http": { "method": "POST", "url": "https://vaults.$region.oci.oraclecloud.com/20180608/secrets/:secretId/version/:secretVersionNumber/actions/scheduleDeletion", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "secretId", "value": "", "type": "path", "description": "The OCID of the secret." }, { "name": "secretVersionNumber", "value": "", "type": "path", "description": "The version number of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Schedules the deletion of the specified secret version. This deletes it after the specified retention period ends. You can only\ndelete a secret version if the secret version rotation state is marked as `DEPRECATED`.\n" }, { "info": { "name": "Lists all secret versions for a secret.", "type": "http" }, "http": { "method": "GET", "url": "https://vaults.$region.oci.oraclecloud.com/20180608/secrets/:secretId/versions", "headers": [ { "name": "opc-request-id", "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": "secretId", "value": "", "type": "path", "description": "The OCID of the secret." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Time created is default ordered as descending. Display name is default ordered as ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "docs": "Lists all secret versions for the specified secret." } ] } ], "bundled": true }