mirrors/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2025-09-19 21:01:09 +02:00
Code Issues Projects Releases Wiki Activity
vault/website/source/api/system/raw.html.md
Chris Hoffman 4a8c33cca3 Disable the sys/raw endpoint by default (#3329) 
* disable raw endpoint by default

* adding docs

* config option raw -> raw_storage_endpoint

* docs updates

* adding listing on raw endpoint

* reworking tests for enabled raw endpoints

* root protecting base raw endpoint
2017-09-15 00:21:35 -04:00

3.2 KiB
Raw Blame History

layout, page_title, sidebar_current, description
layout page_title sidebar_current description
api /sys/raw - HTTP API docs-http-system-raw The `/sys/raw` endpoint is access the raw underlying store in Vault.

/sys/raw

The /sys/raw endpoint is access the raw underlying store in Vault.

This endpont is off by default. See the Vault configuration documentation to enable.

Read Raw

This endpoint reads the value of the key at the given path. This is the raw path in the storage backend and not the logical path that is exposed via the mount system.

Method Path Produces
GET /sys/raw/:path 200 application/json

Parameters

  • path (string: <required>) – Specifies the raw path in the storage backend. This is specified as part of the URL.

Sample Request

$ curl \
    ---header "X-Vault-Token: ..." \
    https://vault.rocks/v1/sys/raw/secret/foo

Sample Response

{
  "value": "{'foo':'bar'}"
}

Create/Update Raw

This endpoint updates the value of the key at the given path. This is the raw path in the storage backend and not the logical path that is exposed via the mount system.

Method Path Produces
PUT /sys/raw/:path 204 (empty body)

Parameters

  • path (string: <required>) – Specifies the raw path in the storage backend. This is specified as part of the URL.

  • value (string: <required>) – Specifies the value of the key.

Sample Payload

{
  "value": "{\"foo\": \"bar\"}"
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request PUT \
    --data @payload.json \
    https://vault.rocks/v1/sys/raw/secret/foo

List Raw

This endpoint returns a list keys for a given path prefix.

This endpoint requires 'sudo' capability.

Method Path Produces
LIST /sys/raw/:prefix 200 application/json
GET /sys/raw/:prefix?list=true 200 application/json

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request LIST \
    https://vault.rocks/v1/sys/raw/logical

Sample Response

{
  "data":{
    "keys":[
      "abcd-1234...",
      "efgh-1234...",
      "ijkl-1234..."
    ]
  }
}

Delete Raw

This endpoint deletes the key with given path. This is the raw path in the storage backend and not the logical path that is exposed via the mount system.

Method Path Produces
DELETE /sys/raw/:path 204 (empty body)

Parameters

  • path (string: <required>) – Specifies the raw path in the storage backend. This is specified as part of the URL.

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request DELETE \
    https://vault.rocks/v1/sys/raw/secret/foo