a3dfde5cec
* conversion stage 1 * correct image paths * add sidebar title to frontmatter * docs/concepts and docs/internals * configuration docs and multi-level nav corrections * commands docs, index file corrections, small item nav correction * secrets converted * auth * add enterprise and agent docs * add extra dividers * secret section, wip * correct sidebar nav title in front matter for apu section, start working on api items * auth and backend, a couple directory structure fixes * remove old docs * intro side nav converted * reset sidebar styles, add hashi-global-styles * basic styling for nav sidebar * folder collapse functionality * patch up border length on last list item * wip restructure for content component * taking middleman hacking to the extreme, but its working * small css fix * add new mega nav * fix a small mistake from the rebase * fix a content resolution issue with middleman * title a couple missing docs pages * update deps, remove temporary markup * community page * footer to layout, community page css adjustments * wip downloads page * deps updated, downloads page ready * fix community page * homepage progress * add components, adjust spacing * docs and api landing pages * a bunch of fixes, add docs and api landing pages * update deps, add deploy scripts * add readme note * update deploy command * overview page, index title * Update doc fields Note this still requires the link fields to be populated -- this is solely related to copy on the description fields * Update api_basic_categories.yml Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages. * Add bottom hero, adjust CSS, responsive friendly * Add mega nav title * homepage adjustments, asset boosts * small fixes * docs page styling fixes * meganav title * some category link corrections * Update API categories page updated to reflect the second level headings for api categories * Update docs_detailed_categories.yml Updated to represent the existing docs structure * Update docs_detailed_categories.yml * docs page data fix, extra operator page remove * api data fix * fix makefile * update deps, add product subnav to docs and api landing pages * Rearrange non-hands-on guides to _docs_ Since there is no place for these on learn.hashicorp, we'll put them under _docs_. * WIP Redirects for guides to docs * content and component updates * font weight hotfix, redirects * fix guides and intro sidenavs * fix some redirects * small style tweaks * Redirects to learn and internally to docs * Remove redirect to `/vault` * Remove `.html` from destination on redirects * fix incorrect index redirect * final touchups * address feedback from michell for makefile and product downloads
141 lines
3.3 KiB
Markdown
141 lines
3.3 KiB
Markdown
---
|
||
layout: "api"
|
||
page_title: "/sys/raw - HTTP API"
|
||
sidebar_title: "<tt>/sys/raw</tt>"
|
||
sidebar_current: "api-http-system-raw"
|
||
description: |-
|
||
The `/sys/raw` endpoint is used to access the raw underlying store in Vault.
|
||
---
|
||
|
||
# `/sys/raw`
|
||
|
||
The `/sys/raw` endpoint is used to access the raw underlying store in Vault.
|
||
|
||
This endpoint is off by default. See the
|
||
[Vault configuration documentation](/docs/configuration/index.html) 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: ..." \
|
||
http://127.0.0.1:8200/v1/sys/raw/secret/foo
|
||
```
|
||
|
||
### Sample Response
|
||
|
||
```json
|
||
{
|
||
"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
|
||
|
||
```json
|
||
{
|
||
"value": "{\"foo\": \"bar\"}"
|
||
}
|
||
```
|
||
|
||
### Sample Request
|
||
|
||
```
|
||
$ curl \
|
||
--header "X-Vault-Token: ..." \
|
||
--request PUT \
|
||
--data @payload.json \
|
||
http://127.0.0.1:8200/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 \
|
||
http://127.0.0.1:8200/v1/sys/raw/logical
|
||
```
|
||
|
||
### Sample Response
|
||
|
||
```json
|
||
{
|
||
"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 \
|
||
http://127.0.0.1:8200/v1/sys/raw/secret/foo
|
||
```
|