Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Wrap Response

POST
/vault/v1/workspaces/{workspace}/wrapping:wrap
 
curl --request POST \
  --url https://example.com/vault/v1/workspaces/example/wrapping:wrap \
  --header 'Content-Type: application/json' \
  --data '{ "workspace": "example", "ttl_seconds": "example", "payload": "example" }'

Wraps an opaque payload in the vault backend and returns a one-time bearer token. The token’s TTL is set by the caller (max 24h enforced engine-side per the vault backend defaults). The original payload never crosses back to the caller — only the consumer that redeems the token sees it again.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace
required
string

The workspace under which the payload is wrapped.

Request Body required

Section titled “Request Body required ”
Media type application/json

Request payload for Wrap Response

Carries the input fields required to wrap response.

object
workspace
required

The workspace under which the payload is wrapped.

string
ttl_seconds
required

Time-to-live in seconds. Token expires automatically when reached.

string
payload
required

The payload to wrap, as opaque bytes. Treated as base64 in REST.

string format: bytes
Example generated
{
  "workspace": "example",
  "ttl_seconds": "example",
  "payload": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response payload from Wrap Response

Carries the output produced by wrap response.

object
token

The one-time wrapping token. Returned exactly once — clients MUST persist it before delivering it to the consumer.

stringOutput only
ttl_seconds

Echoed TTL in seconds.

stringOutput only
creation_time

Engine-side wrap-time creation timestamp.

string format: date-time Output only
Example generated
{}

default

Section titled “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"
    }
  ]
}