Read Wallet

get https://{region}.api.clumio.com/wallets/{wallet_id}

Returns a representation of the specified KMS wallet.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

_embedded

object

Embedded responses related to the resource.

Has additional fields

_links

object

URLs to pages related to the resource.

_self

object

The HATEOAS link to this resource.

delete-wallet

object

A resource-specific HATEOAS link.

list-wallet-keys

object

A resource-specific HATEOAS link.

refresh-wallet

object

A resource-specific HATEOAS link.

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.

string

The Clumio-assigned ID of the wallet.

installed_regions

array of strings

The regions where the wallet is installed.

installed_regions

key_errors

object

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

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

array of strings

The supported regions for the wallet.

supported_regions

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.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us-west-2.api.clumio.com/wallets/wallet_id \
3
     --header 'accept: application/api.clumio.wallets=v1+json'


xxxxxxxxxx
49
}
1
{
2
  "_embedded": {},
3
  "_links": {
4
    "_self": {
5
      "href": "string",
6
      "templated": true,
7
      "type": "string"
8
    },
9
    "delete-wallet": {
10
      "href": "string",
11
      "templated": true,
12
      "type": "string"
13
    },
14
    "list-wallet-keys": {
15
      "href": "string",
16
      "templated": true,
17
      "type": "string"
18
    },
19
    "refresh-wallet": {
20
      "href": "string",
21
      "templated": true,
22
      "type": "string"
23
    }
24
  },
25
  "account_native_id": "string",

200200 HTTP success response

defaultError