Redeem Capsule

POST

/vault/alpha/capsules/{id}:redeem

curl --request POST \
  --url https://example.com/vault/alpha/capsules/example:redeem \
  --header 'Content-Type: application/json' \
  --data '{ "redemption_secret": "example" }'

Collects the payload, once. The capsule becomes REDEEMED and its payload is destroyed; a second attempt is refused.

The authorising half of the split token travels in the request BODY, never in the path, a query string or a header — so it does not land in an access log, a browser history or a referrer, whatever route the link took to reach the recipient.

Parameters

Path Parameters

id

required

string

The capsule to collect.

Request Body ^required

Media type application/json

Capsule Redemption

The authorising half of the split token, carried in the request body so it stays out of access logs, browser history and referrers — whatever route the link took to reach the recipient.

object

redemption_secret

required

The authorising half, as returned to the sender exactly once at creation.

string

Example ^generated

{
  "redemption_secret": "example"
}

Responses

200

OK

Media type application/json

Redeem Capsule Response

The delivered payload and its media type. Returned exactly once; a second attempt on the same capsule is refused.

object

payload

The delivered payload. Returned exactly once, to the first caller that presents the authorising half while the capsule is still active.

string format: bytes Output only

content_type

The payload’s IANA media type, so a client knows how to render it.

stringOutput only

Example ^generated

{}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}