Skip to main content

Refresh Wallet​

Refresh the access status of a wallet with the specified id to verify if it can be used for backup/restore.

Path Parameters
  • wallet_id string required

    Performs the operation on the wallet with the specified ID.

Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • _links object

    URLs to pages related to the resource.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • delete-wallet object

    A resource-specific HATEOAS link.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • list-wallet-keys object

    A resource-specific HATEOAS link.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • refresh-wallet object

    A resource-specific HATEOAS link.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • account_native_id string

    AWS Account ID associated with the wallet.

  • available_version int64

    Version of the template available

  • clumio_aws_account_id string

    Clumio AWS Account ID.

  • deployment_url string

    DeploymentURL is an (external) link to an AWS console page for quick-creation of the stack.

  • error_code string

    ErrorCode is a short string describing the error, if any.

  • error_message string

    ErrorMessage is a longer description explaining the error, if any, and how to fix it.

  • id string

    The Clumio-assigned ID of the wallet.

  • installed_regions string[]

    The regions where the wallet is installed.

  • key_errors object

    Errors, if any, in accessing the multi-region key in the wallet.

  • property name* object
  • role_arn string

    RoleArn is the AWS Resource Name of the IAM Role created by the stack.

  • stack_version int64

    The version of the stack used or being used.

  • state string

    State describes the state of the wallet. Valid states are: Waiting: The wallet has been created, but a stack hasn't been created. The wallet can't be used in this state. Enabled: The wallet has been created and a stack has been created for the wallet. This is the normal expected state of a wallet in use. Error: The wallet is inaccessible. See ErrorCode and ErrorMessage fields for additional details.

  • supported_regions string[]

    The supported regions for the wallet.

  • template_url string

    TemplateURL is the URL to the CloudFormation template to be used to create the CloudFormation stack.

  • token string

    Token is used to identify and authenticate the CloudFormation stack creation.

POST /wallets/:wallet_id/_refresh

Authorization

Request

Click Edit to configure Base URL
https://us-west-2.api.clumio.com
Bearer Token
wallet_id — path required
curl -L -X POST 'https://us-west-2.api.clumio.com/wallets/:wallet_id/_refresh' \
-H 'Accept: application/api.clumio.wallets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'