All Products
Search

This Product

    Key Management Service:RestoreSecret

    Document Center

    Key Management Service:RestoreSecret

    Last Updated:Aug 28, 2026

    Restores a deleted secret that is within its recovery period.

    Operation description

    This operation restores a deleted secret only within its recovery period. If ForceDeleteWithoutRecovery was set to true when the secret was deleted, it cannot be restored.

    For the access policy required by a RAM user or RAM role to call this operation, see Resource Access Management.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SecretName

    string

    Yes

    The name of the secret to restore.

    secret001

    Response elements

    Element

    Type

    Description

    Example

    object

    SecretName

    string

    The name of the secret.

    secret001
    RequestId

    string

    The request ID.

    e4885adf-548f-4ca5-8075-f540bbd3a55f

    Examples

    Success response

    JSON format

    {
  "SecretName": "secret001",
  "RequestId": "e4885adf-548f-4ca5-8075-f540bbd3a55f"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter some of the specified parameters "\" is not valid
    500 InternalFailure Internal Failure
    403 Forbidden.NoPermission This operation is forbidden by permission system
    404 Forbidden.ResourceNotFound Resource not found
    409 Rejected.ResourceInUse restore normal secret

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.