2017-06-17 05:26:25 +00:00
---
layout: "api"
page_title: "/sys/config/cors - HTTP API"
2018-10-29 19:58:37 +00:00
sidebar_title: "< code > /sys/config/cors< / code > "
New Docs Website (#5535)
* 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
2018-10-19 15:40:11 +00:00
sidebar_current: "api-http-system-config-cors"
2017-06-17 05:26:25 +00:00
description: |-
The '/sys/config/cors' endpoint configures how the Vault server responds to cross-origin requests.
---
# `/sys/config/cors`
The `/sys/config/cors` endpoint is used to configure CORS settings.
- **`sudo` required** – All CORS endpoints require `sudo` capability in
addition to any path-specific capabilities.
## Read CORS Settings
This endpoint returns the current CORS configuration.
2019-03-22 16:15:37 +00:00
| Method | Path |
| :--------------------------- | :--------------------- |
| `GET` | `/sys/config/cors` |
2017-06-17 05:26:25 +00:00
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/config/cors
2017-06-17 05:26:25 +00:00
```
### Sample Response
```json
{
"enabled": true,
2017-08-07 14:03:30 +00:00
"allowed_origins": ["http://www.example.com"],
"allowed_headers": [
"Content-Type",
"X-Requested-With",
"X-Vault-AWS-IAM-Server-ID",
"X-Vault-No-Request-Forwarding",
"X-Vault-Token",
2018-10-17 14:38:15 +00:00
"Authorization",
2017-08-07 14:03:30 +00:00
"X-Vault-Wrap-Format",
"X-Vault-Wrap-TTL",
]
2017-06-17 05:26:25 +00:00
}
```
## Configure CORS Settings
This endpoint allows configuring the origins that are permitted to make
2017-08-07 14:03:30 +00:00
cross-origin requests, as well as headers that are allowed on cross-origin requests.
2017-06-17 05:26:25 +00:00
2019-03-22 16:15:37 +00:00
| Method | Path |
| :--------------------------- | :--------------------- |
| `PUT` | `/sys/config/cors` |
2017-06-17 05:26:25 +00:00
### Parameters
2017-08-07 14:03:30 +00:00
- `allowed_origins` `(string or string array: <required>)` – A wildcard (`*`), comma-delimited string, or array of strings specifying the origins that are permitted to make cross-origin requests.
- `allowed_headers` `(string or string array: "" or [])` – A comma-delimited string or array of strings specifying headers that are permitted to be on cross-origin requests. Headers set via this parameter will be appended to the list of headers that Vault allows by default.
2017-06-17 05:26:25 +00:00
### Sample Payload
```json
{
2017-08-07 14:03:30 +00:00
"allowed_origins": "*",
"allowed_headers": "X-Custom-Header"
2017-06-17 05:26:25 +00:00
}
```
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request PUT \
--data @payload .json \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/config/cors
2017-06-17 05:26:25 +00:00
```
## Delete CORS Settings
This endpoint removes any CORS configuration.
2019-03-22 16:15:37 +00:00
| Method | Path |
| :--------------------------- | :--------------------- |
| `DELETE` | `/sys/config/cors` |
2017-06-17 05:26:25 +00:00
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request DELETE \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/config/cors
2017-06-17 05:26:25 +00:00
```