open-vault/website/source/docs/http/system/wrapping-wrap.html.md
Seth Vargo 19b2b049c3
Redo docs for system backend
This commit updates the API documentation for the system backend to
break things apart on a per-page basis and provide specific examples.
This pattern will give more flexibility for future documentation as
well.
2017-03-16 09:46:49 -07:00

1.4 KiB
Raw Blame History

layout page_title sidebar_current description
http /sys/wrapping/wrap - HTTP API docs-http-system-wrapping-wrap The `/sys/wrapping/wrap` endpoint wraps the given values in a response-wrapped token.

/sys/wrapping/wrap

The /sys/wrapping/wrap endpoint wraps the given values in a response-wrapped token.

Wrapping Wrap

This endpoint wraps the given user-supplied data inside a response-wrapped token.

Method Path Produces
POST /sys/wrapping/wrap 200 application/json

Parameters

  • :any (map<string|string>: nil)  Parameters should be supplied as keys/values in a JSON object. The exact set of given parameters will be contained in the wrapped response.

Sample Payload

{
  "foo": "bar",
  "zip": "zap"
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    https://vault.rocks/v1/sys/wrapping/wrap

Sample Response

{
  "request_id": "",
  "lease_id": "",
  "lease_duration": 0,
  "renewable": false,
  "data": null,
  "warnings": null,
  "wrap_info": {
    "token": "fb79b9d3-d94e-9eb6-4919-c559311133d6",
    "ttl": 300,
    "creation_time": "2016-09-28T14:41:00.56961496-04:00",
    "wrapped_accessor": ""
  }
}