open-vault/website/source/docs/http/system/wrapping-rewrap.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.5 KiB
Raw Blame History

layout page_title sidebar_current description
http /sys/wrapping/rewrap - HTTP API docs-http-system-wrapping-rewrap The `/sys/wrapping/rewrap` endpoint can be used to rotate a wrapping token and refresh its TTL.

/sys/wrapping/rewrap

The /sys/wrapping/rewrap endpoint can be used to rotate a wrapping token and refresh its TTL.

Wrapping Rewrap

This endpoint rewraps a response-wrapped token. The new token will use the same creation TTL as the original token and contain the same response. The old token will be invalidated. This can be used for long-term storage of a secret in a response-wrapped token when rotation is a requirement.

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

Parameters

  • token (string: <required>) Specifies the wrapping token ID.

Sample Payload

{
  "token": "abcd1234...",
}

Sample Request

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

Sample Response

{
  "request_id": "",
  "lease_id": "",
  "lease_duration": 0,
  "renewable": false,
  "data": null,
  "warnings": null,
  "wrap_info": {
    "token": "3b6f1193-0707-ac17-284d-e41032e74d1f",
    "ttl": 300,
    "creation_time": "2016-09-28T14:22:26.486186607-04:00",
    "wrapped_accessor": ""
  }
}