feat(website): migrates nav data format and updates docs pages (#11242)

* migrates nav data format and updates docs pages

* removes sidebar_title from content files
This commit is contained in:
Bryce Kalow
2021-04-06 12:49:04 -05:00
committed by GitHub
parent 759f9c1f21
commit e27b43c482
555 changed files with 3409 additions and 2301 deletions

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: AliCloud - Auth Methods - HTTP API page_title: AliCloud - Auth Methods - HTTP API
sidebar_title: AliCloud
description: This is the API documentation for the Vault AliCloud auth method. description: This is the API documentation for the Vault AliCloud auth method.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: AppID - Auth Methods - HTTP API page_title: AppID - Auth Methods - HTTP API
sidebar_title: App ID <sup>DEPRECATED</sup>
description: This is the API documentation for the Vault App ID auth method. description: This is the API documentation for the Vault App ID auth method.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: AppRole - Auth Methods - HTTP API page_title: AppRole - Auth Methods - HTTP API
sidebar_title: AppRole
description: This is the API documentation for the Vault AppRole auth method. description: This is the API documentation for the Vault AppRole auth method.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: AWS - Auth Methods - HTTP API page_title: AWS - Auth Methods - HTTP API
sidebar_title: AWS
description: This is the API documentation for the Vault AWS auth method. description: This is the API documentation for the Vault AWS auth method.
--- ---
@@ -517,7 +516,7 @@ $ curl \
Configures the periodic tidying operation of the access listed identity entries. Configures the periodic tidying operation of the access listed identity entries.
| Method | Path | | Method | Path |
| :----- | :----------------------------------------- | | :----- | :------------------------------------------ |
| `POST` | `/auth/aws/config/tidy/identity-accesslist` | | `POST` | `/auth/aws/config/tidy/identity-accesslist` |
### Parameters ### Parameters
@@ -551,7 +550,7 @@ $ curl \
Returns the previously configured periodic access list tidying settings. Returns the previously configured periodic access list tidying settings.
| Method | Path | | Method | Path |
| :----- | :----------------------------------------- | | :----- | :------------------------------------------ |
| `GET` | `/auth/aws/config/tidy/identity-accesslist` | | `GET` | `/auth/aws/config/tidy/identity-accesslist` |
### Sample Request ### Sample Request
@@ -578,7 +577,7 @@ $ curl \
Deletes the previously configured periodic access list tidying settings. Deletes the previously configured periodic access list tidying settings.
| Method | Path | | Method | Path |
| :------- | :----------------------------------------- | | :------- | :------------------------------------------ |
| `DELETE` | `/auth/aws/config/tidy/identity-accesslist` | | `DELETE` | `/auth/aws/config/tidy/identity-accesslist` |
### Sample Request ### Sample Request
@@ -595,7 +594,7 @@ $ curl \
Configures the periodic tidying operation of the deny listed role tag entries. Configures the periodic tidying operation of the deny listed role tag entries.
| Method | Path | | Method | Path |
| :----- | :---------------------------------------- | | :----- | :--------------------------------------- |
| `POST` | `/auth/aws/config/tidy/roletag-denylist` | | `POST` | `/auth/aws/config/tidy/roletag-denylist` |
### Parameters ### Parameters
@@ -629,7 +628,7 @@ $ curl \
Returns the previously configured periodic deny list tidying settings. Returns the previously configured periodic deny list tidying settings.
| Method | Path | | Method | Path |
| :----- | :---------------------------------------- | | :----- | :--------------------------------------- |
| `GET` | `/auth/aws/config/tidy/roletag-denylist` | | `GET` | `/auth/aws/config/tidy/roletag-denylist` |
### Sample Request ### Sample Request
@@ -656,7 +655,7 @@ $ curl \
Deletes the previously configured periodic deny list tidying settings. Deletes the previously configured periodic deny list tidying settings.
| Method | Path | | Method | Path |
| :------- | :---------------------------------------- | | :------- | :--------------------------------------- |
| `DELETE` | `/auth/aws/config/tidy/roletag-denylist` | | `DELETE` | `/auth/aws/config/tidy/roletag-denylist` |
### Sample Request ### Sample Request
@@ -1110,7 +1109,7 @@ placing the tag in the deny list does not invalidate the already issued
token. token.
| Method | Path | | Method | Path |
| :----- | :-------------------------------------- | | :----- | :------------------------------------- |
| `POST` | `/auth/aws/roletag-denylist/:role_tag` | | `POST` | `/auth/aws/roletag-denylist/:role_tag` |
### Parameters ### Parameters
@@ -1133,7 +1132,7 @@ $ curl \
Returns the deny list entry of a previously deny listed role tag. Returns the deny list entry of a previously deny listed role tag.
| Method | Path | | Method | Path |
| :----- | :-------------------------------------- | | :----- | :------------------------------------- |
| `GET` | `/auth/aws/roletag-denylist/:role_tag` | | `GET` | `/auth/aws/roletag-denylist/:role_tag` |
### Parameters ### Parameters
@@ -1166,7 +1165,7 @@ $ curl \
Lists all the role tags that are deny listed. Lists all the role tags that are deny listed.
| Method | Path | | Method | Path |
| :----- | :---------------------------- | | :----- | :--------------------------- |
| `LIST` | `/auth/aws/roletag-denylist` | | `LIST` | `/auth/aws/roletag-denylist` |
### Sample Request ### Sample Request
@@ -1195,7 +1194,7 @@ $ curl \
Deletes a deny listed role tag. Deletes a deny listed role tag.
| Method | Path | | Method | Path |
| :------- | :-------------------------------------- | | :------- | :------------------------------------- |
| `DELETE` | `/auth/aws/roletag-denylist/:role_tag` | | `DELETE` | `/auth/aws/roletag-denylist/:role_tag` |
### Parameters ### Parameters
@@ -1219,7 +1218,7 @@ Cleans up the entries in the deny listed based on expiration time on the entry a
`safety_buffer`. `safety_buffer`.
| Method | Path | | Method | Path |
| :----- | :--------------------------------- | | :----- | :-------------------------------- |
| `POST` | `/auth/aws/tidy/roletag-denylist` | | `POST` | `/auth/aws/tidy/roletag-denylist` |
### Parameters ### Parameters
@@ -1243,7 +1242,7 @@ Returns an entry in the identity access list. An entry will be created/updated b
successful login. successful login.
| Method | Path | | Method | Path |
| :----- | :------------------------------------------ | | :----- | :------------------------------------------- |
| `GET` | `/auth/aws/identity-accesslist/:instance_id` | | `GET` | `/auth/aws/identity-accesslist/:instance_id` |
### Parameters ### Parameters
@@ -1279,7 +1278,7 @@ $ curl \
Lists all the instance IDs that are in the access list of successful logins. Lists all the instance IDs that are in the access list of successful logins.
| Method | Path | | Method | Path |
| :----- | :----------------------------- | | :----- | :------------------------------ |
| `LIST` | `/auth/aws/identity-accesslist` | | `LIST` | `/auth/aws/identity-accesslist` |
### Sample Request ### Sample Request
@@ -1306,7 +1305,7 @@ $ curl \
Deletes a cache of the successful login from an instance. Deletes a cache of the successful login from an instance.
| Method | Path | | Method | Path |
| :------- | :------------------------------------------ | | :------- | :------------------------------------------- |
| `DELETE` | `/auth/aws/identity-accesslist/:instance_id` | | `DELETE` | `/auth/aws/identity-accesslist/:instance_id` |
### Parameters ### Parameters
@@ -1330,7 +1329,7 @@ Cleans up the entries in the access list based on expiration time and
`safety_buffer`. `safety_buffer`.
| Method | Path | | Method | Path |
| :----- | :---------------------------------- | | :----- | :----------------------------------- |
| `POST` | `/auth/aws/tidy/identity-accesslist` | | `POST` | `/auth/aws/tidy/identity-accesslist` |
### Parameters ### Parameters
@@ -1361,4 +1360,3 @@ URLs are deprecated. The affected APIs include:
| `/auth/aws/tidy/roletag-denylist` | `/auth/aws/tidy/roletag-blacklist` | | `/auth/aws/tidy/roletag-denylist` | `/auth/aws/tidy/roletag-blacklist` |
| `/auth/aws/config/tidy/identity-accesslist` | `/auth/aws/config/tidy/identity-whitelist` | | `/auth/aws/config/tidy/identity-accesslist` | `/auth/aws/config/tidy/identity-whitelist` |
| `/auth/aws/config/tidy/roletag-denylist` | `/auth/aws/config/tidy/roletag-blacklist` | | `/auth/aws/config/tidy/roletag-denylist` | `/auth/aws/config/tidy/roletag-blacklist` |

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Azure - Auth Methods - HTTP API page_title: Azure - Auth Methods - HTTP API
sidebar_title: Azure
description: |- description: |-
This is the API documentation for the Vault Azure authentication This is the API documentation for the Vault Azure authentication
method plugin. method plugin.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: TLS Certificate - Auth Methods - HTTP API page_title: TLS Certificate - Auth Methods - HTTP API
sidebar_title: TLS Certificates
description: |- description: |-
This is the API documentation for the Vault TLS Certificate authentication This is the API documentation for the Vault TLS Certificate authentication
method. method.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Cloud Foundry - Auth Methods - HTTP API page_title: Cloud Foundry - Auth Methods - HTTP API
sidebar_title: Cloud Foundry
description: This is the API documentation for the Vault Cloud Foundry auth method. description: This is the API documentation for the Vault Cloud Foundry auth method.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Google Cloud - Auth Methods - HTTP API page_title: Google Cloud - Auth Methods - HTTP API
sidebar_title: Google Cloud
description: |- description: |-
This is the API documentation for the Vault Google Cloud authentication This is the API documentation for the Vault Google Cloud authentication
method. method.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: GitHub - Auth Methods - HTTP API page_title: GitHub - Auth Methods - HTTP API
sidebar_title: GitHub
description: This is the API documentation for the Vault GitHub auth method. description: This is the API documentation for the Vault GitHub auth method.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Auth Methods - HTTP API page_title: Auth Methods - HTTP API
sidebar_title: Auth Methods
description: |- description: |-
Each auth method publishes its own set of API paths and methods. Each auth method publishes its own set of API paths and methods.
These endpoints are documented in this section. These endpoints are documented in this section.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: JWT/OIDC - Auth Methods - HTTP API page_title: JWT/OIDC - Auth Methods - HTTP API
sidebar_title: JWT/OIDC
description: |- description: |-
This is the API documentation for the Vault JWT/OIDC authentication This is the API documentation for the Vault JWT/OIDC authentication
method plugin. method plugin.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Kerberos - Auth Methods - HTTP API page_title: Kerberos - Auth Methods - HTTP API
sidebar_title: Kerberos
description: This is the API documentation for the Vault Kerberos auth method plugin. description: This is the API documentation for the Vault Kerberos auth method plugin.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Kubernetes - Auth Methods - HTTP API page_title: Kubernetes - Auth Methods - HTTP API
sidebar_title: Kubernetes
description: This is the API documentation for the Vault Kubernetes auth method plugin. description: This is the API documentation for the Vault Kubernetes auth method plugin.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: LDAP - Auth Methods - HTTP API page_title: LDAP - Auth Methods - HTTP API
sidebar_title: LDAP
description: This is the API documentation for the Vault LDAP auth method. description: This is the API documentation for the Vault LDAP auth method.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: OCI - Auth Methods - HTTP API page_title: OCI - Auth Methods - HTTP API
sidebar_title: OCI
description: This is the API documentation for the Vault OCI auth method plugin. description: This is the API documentation for the Vault OCI auth method plugin.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Okta - Auth Methods - HTTP API page_title: Okta - Auth Methods - HTTP API
sidebar_title: Okta
description: This is the API documentation for the Vault Okta auth method. description: This is the API documentation for the Vault Okta auth method.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: RADIUS - Auth Methods - HTTP API page_title: RADIUS - Auth Methods - HTTP API
sidebar_title: RADIUS
description: This is the API documentation for the Vault RADIUS auth method. description: This is the API documentation for the Vault RADIUS auth method.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Token - Auth Methods - HTTP API page_title: Token - Auth Methods - HTTP API
sidebar_title: Tokens
description: This is the API documentation for the Vault token auth method. description: This is the API documentation for the Vault token auth method.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Userpass - Auth Methods - HTTP API page_title: Userpass - Auth Methods - HTTP API
sidebar_title: Username & Password
description: |- description: |-
This is the API documentation for the Vault username and password This is the API documentation for the Vault username and password
auth method. auth method.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: HTTP API page_title: HTTP API
sidebar_title: Overview
description: Vault has an HTTP API that can be used to control every aspect of Vault. description: Vault has an HTTP API that can be used to control every aspect of Vault.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: 'HTTP API: Libraries' page_title: 'HTTP API: Libraries'
sidebar_title: Client Libraries
description: >- description: >-
List of official and community contributed libraries for interacting with the List of official and community contributed libraries for interacting with the
Vault HTTP API. Vault HTTP API.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Related Tools page_title: Related Tools
sidebar_title: Related Tools
description: Short list of third-party tools that work with or are related to Vault. description: Short list of third-party tools that work with or are related to Vault.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Active Directory - Secrets Engines - HTTP API page_title: Active Directory - Secrets Engines - HTTP API
sidebar_title: Active Directory
description: This is the API documentation for the Vault Active Directory secrets engine. description: This is the API documentation for the Vault Active Directory secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: AliCloud - Secrets Engines - HTTP API page_title: AliCloud - Secrets Engines - HTTP API
sidebar_title: AliCloud
description: This is the API documentation for the Vault AliCloud secrets engine. description: This is the API documentation for the Vault AliCloud secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: AWS - Secrets Engines - HTTP API page_title: AWS - Secrets Engines - HTTP API
sidebar_title: AWS
description: This is the API documentation for the Vault AWS secrets engine. description: This is the API documentation for the Vault AWS secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Azure - Secrets Engines - HTTP API page_title: Azure - Secrets Engines - HTTP API
sidebar_title: Azure
description: This is the API documentation for the Vault Azure secrets engine. description: This is the API documentation for the Vault Azure secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Cassandra - Secrets Engines - HTTP API page_title: Cassandra - Secrets Engines - HTTP API
sidebar_title: Cassandra <sup>DEPRECATED</sup>
description: This is the API documentation for the Vault Cassandra secrets engine. description: This is the API documentation for the Vault Cassandra secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Consul - Secrets Engines - HTTP API page_title: Consul - Secrets Engines - HTTP API
sidebar_title: Consul
description: This is the API documentation for the Vault Consul secrets engine. description: This is the API documentation for the Vault Consul secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Cubbyhole - Secrets Engines - HTTP API page_title: Cubbyhole - Secrets Engines - HTTP API
sidebar_title: Cubbyhole
description: This is the API documentation for the Vault Cubbyhole secrets engine. description: This is the API documentation for the Vault Cubbyhole secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Cassandra - Database - Secrets Engines - HTTP API page_title: Cassandra - Database - Secrets Engines - HTTP API
sidebar_title: Cassandra
description: >- description: >-
The Cassandra plugin for Vault's database secrets engine generates database The Cassandra plugin for Vault's database secrets engine generates database
credentials to access Cassandra servers. credentials to access Cassandra servers.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Couchbase - Database - Secrets Engines - HTTP API page_title: Couchbase - Database - Secrets Engines - HTTP API
sidebar_title: Couchbase
description: >- description: >-
The Couchbase plugin for Vault's database secrets engine generates database The Couchbase plugin for Vault's database secrets engine generates database
credentials to access Couchbase servers. credentials to access Couchbase servers.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Elasticsearch - Database - Secrets Engines - HTTP API page_title: Elasticsearch - Database - Secrets Engines - HTTP API
sidebar_title: Elasticsearch
description: >- description: >-
The Elasticsearch plugin for Vault's database secrets engine generates The Elasticsearch plugin for Vault's database secrets engine generates
database credentials to access Elasticsearch. database credentials to access Elasticsearch.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: HANA - Database - Secrets Engines - HTTP API page_title: HANA - Database - Secrets Engines - HTTP API
sidebar_title: HanaDB
description: >- description: >-
The HANA plugin for Vault's database secrets engine generates database The HANA plugin for Vault's database secrets engine generates database
credentials to access HANA servers. credentials to access HANA servers.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Database - Secrets Engines - HTTP API page_title: Database - Secrets Engines - HTTP API
sidebar_title: Databases
description: Top page for database secrets engine information description: Top page for database secrets engine information
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Influxdb - Database - Secrets Engines - HTTP API page_title: Influxdb - Database - Secrets Engines - HTTP API
sidebar_title: Influxdb
description: >- description: >-
The Influxdb plugin for Vault's database secrets engine generates database The Influxdb plugin for Vault's database secrets engine generates database
credentials to access Influxdb servers. credentials to access Influxdb servers.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: MongoDB - Database - Secrets Engines - HTTP API page_title: MongoDB - Database - Secrets Engines - HTTP API
sidebar_title: MongoDB
description: >- description: >-
The MongoDB plugin for Vault's database secrets engine generates database The MongoDB plugin for Vault's database secrets engine generates database
credentials to access MongoDB servers. credentials to access MongoDB servers.

View File

@@ -1,7 +1,6 @@
--- ---
layout: 'api' layout: 'api'
page_title: 'MongoDB Atlas - Database - Secrets Engines - HTTP API' page_title: 'MongoDB Atlas - Database - Secrets Engines - HTTP API'
sidebar_title: 'MongoDB Atlas'
description: |- description: |-
The MongoDB Atlas plugin for Vault's Database Secrets Engine generates MongoDB Database User credentials for MongoDB Atlas. The MongoDB Atlas plugin for Vault's Database Secrets Engine generates MongoDB Database User credentials for MongoDB Atlas.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: MSSQL - Database - Secrets Engines - HTTP API page_title: MSSQL - Database - Secrets Engines - HTTP API
sidebar_title: MSSQL
description: >- description: >-
The MSSQL plugin for Vault's database secrets engine generates database The MSSQL plugin for Vault's database secrets engine generates database
credentials to access MSSQL servers. credentials to access MSSQL servers.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: MySQL/MariaDB - Database - Secrets Engines - HTTP API page_title: MySQL/MariaDB - Database - Secrets Engines - HTTP API
sidebar_title: MySQL/MariaDB
description: >- description: >-
The MySQL/MariaDB plugin for Vault's database secrets engine generates The MySQL/MariaDB plugin for Vault's database secrets engine generates
database credentials to access MySQL and MariaDB servers. database credentials to access MySQL and MariaDB servers.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Oracle - Database - Secrets Engines - HTTP API page_title: Oracle - Database - Secrets Engines - HTTP API
sidebar_title: Oracle
description: >- description: >-
The Oracle plugin for Vault's database secrets engine generates database The Oracle plugin for Vault's database secrets engine generates database
credentials to access Oracle servers. credentials to access Oracle servers.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: PostgreSQL - Database - Secrets Engines - HTTP API page_title: PostgreSQL - Database - Secrets Engines - HTTP API
sidebar_title: PostgreSQL
description: >- description: >-
The PostgreSQL plugin for Vault's database secrets engine generates database The PostgreSQL plugin for Vault's database secrets engine generates database
credentials to access PostgreSQL servers. credentials to access PostgreSQL servers.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Redshift - Database - Secrets Engines - HTTP API page_title: Redshift - Database - Secrets Engines - HTTP API
sidebar_title: Redshift
description: >- description: >-
The Redshift plugin for Vault's database secrets engine generates database The Redshift plugin for Vault's database secrets engine generates database
credentials to access the AWS Redshift service. credentials to access the AWS Redshift service.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Snowflake - Database - Secrets Engines - HTTP API page_title: Snowflake - Database - Secrets Engines - HTTP API
sidebar_title: Snowflake
description: >- description: >-
The Snowflake plugin for Vault's database secrets engine generates database The Snowflake plugin for Vault's database secrets engine generates database
credentials to access Snowflake servers. credentials to access Snowflake servers.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Google Cloud - Secrets Engines - HTTP API page_title: Google Cloud - Secrets Engines - HTTP API
sidebar_title: Google Cloud
description: This is the API documentation for the Vault Google Cloud secrets engine. description: This is the API documentation for the Vault Google Cloud secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Google Cloud KMS - Secrets Engines - HTTP API page_title: Google Cloud KMS - Secrets Engines - HTTP API
sidebar_title: Google Cloud KMS
description: This is the API documentation for the Vault Google Cloud KMS secrets engine. description: This is the API documentation for the Vault Google Cloud KMS secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: 'Identity Secret Backend: Entity Alias - HTTP API' page_title: 'Identity Secret Backend: Entity Alias - HTTP API'
sidebar_title: Entity Alias
description: >- description: >-
This is the API documentation for managing entity aliases in the identity This is the API documentation for managing entity aliases in the identity
store. store.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: 'Identity Secret Backend: Entity - HTTP API' page_title: 'Identity Secret Backend: Entity - HTTP API'
sidebar_title: Entity
description: This is the API documentation for managing entities in the identity store. description: This is the API documentation for managing entities in the identity store.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: 'Identity Secret Backend: Group Alias - HTTP API' page_title: 'Identity Secret Backend: Group Alias - HTTP API'
sidebar_title: Group Alias
description: >- description: >-
This is the API documentation for managing the group aliases in the identity This is the API documentation for managing the group aliases in the identity
store. store.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: 'Identity Secret Backend: Group - HTTP API' page_title: 'Identity Secret Backend: Group - HTTP API'
sidebar_title: Group
description: This is the API documentation for managing groups in the identity store. description: This is the API documentation for managing groups in the identity store.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Identity - Secrets Engines - HTTP API page_title: Identity - Secrets Engines - HTTP API
sidebar_title: Identity
description: This is the API documentation for the Vault Identity secrets engine. description: This is the API documentation for the Vault Identity secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: 'Identity Secret Backend: Lookup - HTTP API' page_title: 'Identity Secret Backend: Lookup - HTTP API'
sidebar_title: Lookup
description: |- description: |-
This is the API documentation for entity and group lookups from identity This is the API documentation for entity and group lookups from identity
store. store.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: 'Identity Secret Backend: Identity Tokens - HTTP API' page_title: 'Identity Secret Backend: Identity Tokens - HTTP API'
sidebar_title: Identity Tokens
description: >- description: >-
This is the API documentation for configuring, acquiring, and validating vault This is the API documentation for configuring, acquiring, and validating vault
issued identity tokens. issued identity tokens.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Secrets Engines - HTTP API page_title: Secrets Engines - HTTP API
sidebar_title: Secrets Engines
description: |- description: |-
Each secrets engine publishes its own set of API paths and methods. These Each secrets engine publishes its own set of API paths and methods. These
endpoints are documented in this section. endpoints are documented in this section.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: AWS KMS - Key Management - Secrets Engines - HTTP API page_title: AWS KMS - Key Management - Secrets Engines - HTTP API
sidebar_title: AWS KMS
description: The AWS KMS API documentation for the Key Management secrets engine. description: The AWS KMS API documentation for the Key Management secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Azure Key Vault - Key Management - Secrets Engines - HTTP API page_title: Azure Key Vault - Key Management - Secrets Engines - HTTP API
sidebar_title: Azure Key Vault
description: The Azure Key Vault API documentation for the Key Management secrets engine. description: The Azure Key Vault API documentation for the Key Management secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Key Management - Secrets Engines - HTTP API page_title: Key Management - Secrets Engines - HTTP API
sidebar_title: Key Management <sup>ENTERPRISE</sup>
description: The API documentation for the Key Management secrets engine. description: The API documentation for the Key Management secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: KMIP - Secrets Engines - HTTP API page_title: KMIP - Secrets Engines - HTTP API
sidebar_title: KMIP <sup>ENTERPRISE</sup>
description: This is the API documentation for the Vault KMIP secrets engine. description: This is the API documentation for the Vault KMIP secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: KV - Secrets Engines - HTTP API page_title: KV - Secrets Engines - HTTP API
sidebar_title: Key/Value
description: This is the API documentation for the Vault KV secrets engine. description: This is the API documentation for the Vault KV secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: KV - Secrets Engines - HTTP API page_title: KV - Secrets Engines - HTTP API
sidebar_title: K/V Version 1
description: This is the API documentation for the Vault KV secrets engine. description: This is the API documentation for the Vault KV secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: KV - Secrets Engines - HTTP API page_title: KV - Secrets Engines - HTTP API
sidebar_title: K/V Version 2
description: This is the API documentation for the Vault KV secrets engine. description: This is the API documentation for the Vault KV secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: MongoDB Atlas - Secrets Engines - HTTP API page_title: MongoDB Atlas - Secrets Engines - HTTP API
sidebar_title: MongoDB Atlas
description: |- description: |-
The MongoDB Atlas Secrets Engine for Vault generates MongoDB Atlas Programmatic API Keys dynamically. The MongoDB Atlas Secrets Engine for Vault generates MongoDB Atlas Programmatic API Keys dynamically.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Nomad Secret Backend - HTTP API page_title: Nomad Secret Backend - HTTP API
sidebar_title: Nomad
description: This is the API documentation for the Vault Nomad secret backend. description: This is the API documentation for the Vault Nomad secret backend.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: OpenLDAP - Secrets Engines - HTTP API page_title: OpenLDAP - Secrets Engines - HTTP API
sidebar_title: OpenLDAP
description: This is the API documentation for the Vault OpenLDAP secrets engine. description: This is the API documentation for the Vault OpenLDAP secrets engine.
--- ---
@@ -226,7 +225,6 @@ $ curl \
http://127.0.0.1:8200/v1/openldap/static-cred/hashicorp http://127.0.0.1:8200/v1/openldap/static-cred/hashicorp
``` ```
#### Sample Get Response #### Sample Get Response
```json ```json
@@ -267,7 +265,7 @@ OpenLDAP domain user account.
#### Parameters #### Parameters
| Method | Path | | Method | Path |
| :------- | :------------------------- | | :------- | :-------------------------- |
| `POST` | `/openldap/role/:role_name` | | `POST` | `/openldap/role/:role_name` |
| `DELETE` | `/openldap/role/:role_name` | | `DELETE` | `/openldap/role/:role_name` |
@@ -341,6 +339,7 @@ The `creation_ldif`, `deletion_ldif`, `rollback_ldif`, and `username_template` f
Sample LDIF files: Sample LDIF files:
`creation.ldif`: `creation.ldif`:
``` ```
dn: cn={{.Username}},ou=users,dc=learn,dc=example dn: cn={{.Username}},ou=users,dc=learn,dc=example
objectClass: person objectClass: person
@@ -387,7 +386,7 @@ $ curl \
### Read Dynamic Role Configuration ### Read Dynamic Role Configuration
| Method | Path | | Method | Path |
| ------ | -------------------------- | | ------ | --------------------------- |
| `GET` | `/openldap/role/:role_name` | | `GET` | `/openldap/role/:role_name` |
Retrieves a dynamic role's configuration. Retrieves a dynamic role's configuration.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: PKI - Secrets Engines - HTTP API page_title: PKI - Secrets Engines - HTTP API
sidebar_title: PKI
description: This is the API documentation for the Vault PKI secrets engine. description: This is the API documentation for the Vault PKI secrets engine.
--- ---
@@ -1611,7 +1610,7 @@ This table outlines which operations can be executed on performance standbys
and thus scale horizontally. and thus scale horizontally.
| Path | Operations | | Path | Operations |
| --------------------------- | ------------------- | | --------------------------- | -------------------- |
| ca[/pem] | Read | | ca[/pem] | Read |
| cert/<em>serial-number</em> | Read | | cert/<em>serial-number</em> | Read |
| cert/ca_chain | Read | | cert/ca_chain | Read |
@@ -1620,15 +1619,12 @@ and thus scale horizontally.
| ca_chain | Read | | ca_chain | Read |
| crl[/pem] | Read | | crl[/pem] | Read |
| crl/pem | Read | | crl/pem | Read |
| issue | Update <sup>*</sup> | | issue | Update <sup>\*</sup> |
| revoked/* | Read, List | | revoked/\* | Read, List |
| sign | Update <sup>*</sup> | | sign | Update <sup>\*</sup> |
| sign-verbatim | Update <sup>*</sup> | | sign-verbatim | Update <sup>\*</sup> |
\* Only if the corresponding role has `no_store` set to true and `generate_lease` \* Only if the corresponding role has `no_store` set to true and `generate_lease`
set to false. If `generate_lease` is true the lease creation will be forwarded to set to false. If `generate_lease` is true the lease creation will be forwarded to
the active node; if `no_store` is false the entire request will be forwarded to the active node; if `no_store` is false the entire request will be forwarded to
the active node. the active node.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: RabbitMQ - Secrets Engines - HTTP API page_title: RabbitMQ - Secrets Engines - HTTP API
sidebar_title: RabbitMQ
description: This is the API documentation for the Vault RabbitMQ secrets engine. description: This is the API documentation for the Vault RabbitMQ secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: SSH - Secrets Engines - HTTP API page_title: SSH - Secrets Engines - HTTP API
sidebar_title: SSH
description: This is the API documentation for the Vault SSH secrets engine. description: This is the API documentation for the Vault SSH secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Terraform Cloud Secret Backend - HTTP API page_title: Terraform Cloud Secret Backend - HTTP API
sidebar_title: Terraform Cloud
description: This is the API documentation for the Vault Terraform Cloud secret backend. description: This is the API documentation for the Vault Terraform Cloud secret backend.
--- ---
@@ -22,7 +21,7 @@ information is used so that Vault can communicate with Terraform Cloud and gener
Terraform Cloud tokens. Terraform Cloud tokens.
| Method | Path | | Method | Path |
| :----- | :--------------------- | | :----- | :------------------ |
| `POST` | `/terraform/config` | | `POST` | `/terraform/config` |
### Parameters ### Parameters
@@ -35,7 +34,6 @@ Terraform Cloud tokens.
use. This token must have the needed permissions to manage all Organization, use. This token must have the needed permissions to manage all Organization,
Team, and User tokens desired for this mount. Team, and User tokens desired for this mount.
### Sample Payload ### Sample Payload
```json ```json
@@ -60,7 +58,7 @@ $ curl \
This endpoint queries for information about the Terraform Cloud connection. This endpoint queries for information about the Terraform Cloud connection.
| Method | Path | | Method | Path |
| :----- | :--------------------- | | :----- | :------------------ |
| `GET` | `/terraform/config` | | `GET` | `/terraform/config` |
### Sample Request ### Sample Request
@@ -80,7 +78,6 @@ $ curl \
} }
``` ```
## Create/Update Role ## Create/Update Role
This endpoint creates or updates the Terraform Cloud role definition in Vault. This endpoint creates or updates the Terraform Cloud role definition in Vault.
@@ -107,9 +104,8 @@ Please see the [Terraform Cloud API
Token documentation for more Token documentation for more
information](https://www.terraform.io/docs/cloud/users-teams-organizations/api-tokens.html). information](https://www.terraform.io/docs/cloud/users-teams-organizations/api-tokens.html).
| Method | Path | | Method | Path |
| :----- | :------------------ | | :----- | :---------------------- |
| `POST` | `/terraform/role/:name` | | `POST` | `/terraform/role/:name` |
### Parameters ### Parameters
@@ -136,7 +132,6 @@ information](https://www.terraform.io/docs/cloud/users-teams-organizations/api-t
as a string duration with a time suffix like `"30s"` or `"1h"` or as seconds. If not as a string duration with a time suffix like `"30s"` or `"1h"` or as seconds. If not
provided, the default Vault Max TTL is used. Only applies to User API tokens. provided, the default Vault Max TTL is used. Only applies to User API tokens.
### Sample Payload ### Sample Payload
To create a Vault role to manage a Terraform Cloud User tokens To create a Vault role to manage a Terraform Cloud User tokens
@@ -145,7 +140,7 @@ To create a Vault role to manage a Terraform Cloud User tokens
{ {
"user_id": "user-glhf1234", "user_id": "user-glhf1234",
"ttl": "1h", "ttl": "1h",
"max_ttl":"24h", "max_ttl": "24h"
} }
``` ```
@@ -165,7 +160,7 @@ This endpoint queries for information about a Terraform Cloud role with the give
If no role exists with that name, a 404 is returned. If no role exists with that name, a 404 is returned.
| Method | Path | | Method | Path |
| :----- | :------------------ | | :----- | :---------------------- |
| `GET` | `/terraform/role/:name` | | `GET` | `/terraform/role/:name` |
### Parameters ### Parameters
@@ -190,7 +185,7 @@ $ curl \
"name": "tfuser", "name": "tfuser",
"ttl": 3600, "ttl": 3600,
"user_id": "user-glhf1234" "user_id": "user-glhf1234"
}, }
} }
``` ```
@@ -199,7 +194,7 @@ $ curl \
This endpoint lists all existing roles in the backend. This endpoint lists all existing roles in the backend.
| Method | Path | | Method | Path |
| :----- | :---------------------- | | :----- | :-------------------------- |
| `LIST` | `/terraform/role` | | `LIST` | `/terraform/role` |
| `GET` | `/terraform/role?list=true` | | `GET` | `/terraform/role?list=true` |
@@ -228,7 +223,7 @@ This endpoint deletes a Terraform Cloud role with the given name. Even if the ro
not exist, this endpoint will still return a successful response. not exist, this endpoint will still return a successful response.
| Method | Path | | Method | Path |
| :------- | :------------------ | | :------- | :---------------------- |
| `DELETE` | `/terraform/role/:name` | | `DELETE` | `/terraform/role/:name` |
### Parameters ### Parameters
@@ -251,9 +246,8 @@ This endpoint rotates the credentials for a Terraform Cloud role that manages an
Organization or Team. This endpoint is only valid for those roles; attempting to Organization or Team. This endpoint is only valid for those roles; attempting to
rotate a role that manages user tokens will result in an error. rotate a role that manages user tokens will result in an error.
| Method | Path | | Method | Path |
| :------- | :------------------ | | :----- | :----------------------------- |
| `POST` | `/terraform/rotate-role/:name` | | `POST` | `/terraform/rotate-role/:name` |
### Parameters ### Parameters
@@ -278,7 +272,7 @@ until the token is rotated with `rotate-role`. For User roles, a new token is
generated with each request. generated with each request.
| Method | Path | | Method | Path |
| :----- | :------------------- | | :----- | :----------------------- |
| `GET` | `/terraform/creds/:name` | | `GET` | `/terraform/creds/:name` |
### Parameters ### Parameters

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: TOTP - Secrets Engines - HTTP API page_title: TOTP - Secrets Engines - HTTP API
sidebar_title: TOTP
description: This is the API documentation for the Vault TOTP secrets engine. description: This is the API documentation for the Vault TOTP secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Transform - Secrets Engines - HTTP API page_title: Transform - Secrets Engines - HTTP API
sidebar_title: Transform <sup>ENTERPRISE</sup>
description: This is the API documentation for the Transform secrets engine. description: This is the API documentation for the Transform secrets engine.
--- ---
@@ -212,7 +211,7 @@ transformation with the name does not exist, it will be created. If the
transformation exists, it will be updated with the new attributes. transformation exists, it will be updated with the new attributes.
| Method | Path | | Method | Path |
| :----- | :------------------------------------ | | :----- | :------------------------------------- |
| `POST` | `/transform/transformations/fpe/:name` | | `POST` | `/transform/transformations/fpe/:name` |
### Parameters ### Parameters
@@ -261,7 +260,7 @@ transformation with the name does not exist, it will be created. If the
transformation exists, it will be updated with the new attributes. transformation exists, it will be updated with the new attributes.
| Method | Path | | Method | Path |
| :----- | :---------------------------------------- | | :----- | :----------------------------------------- |
| `POST` | `/transform/transformations/masking/:name` | | `POST` | `/transform/transformations/masking/:name` |
### Parameters ### Parameters
@@ -311,7 +310,7 @@ transformation with the name does not exist, it will be created. If the
transformation exists, it will be updated with the new attributes. transformation exists, it will be updated with the new attributes.
| Method | Path | | Method | Path |
| :----- | :--------------------------------------------- | | :----- | :---------------------------------------------- |
| `POST` | `/transform/transformations/tokenization/:name` | | `POST` | `/transform/transformations/tokenization/:name` |
### Parameters ### Parameters
@@ -362,7 +361,7 @@ $ curl \
This endpoint queries an existing transformation by the given name. This endpoint queries an existing transformation by the given name.
| Method | Path | | Method | Path |
| :----- | :-------------------------------- | | :----- | :--------------------------------- |
| `GET` | `/transform/transformations/:name` | | `GET` | `/transform/transformations/:name` |
- `name` `(string: <required>)` - `name` `(string: <required>)`
@@ -421,7 +420,7 @@ $ curl
This endpoint deletes an existing transformation by the given name. This endpoint deletes an existing transformation by the given name.
| Method | Path | | Method | Path |
| :------- | :-------------------------------- | | :------- | :--------------------------------- |
| `DELETE` | `/transform/transformations/:name` | | `DELETE` | `/transform/transformations/:name` |
### Parameters ### Parameters
@@ -716,6 +715,7 @@ The database user configured here should only have permission to `SELECT`,
A database connection string with template slots for username and password that A database connection string with template slots for username and password that
Vault will use for locating and connecting to a database. Each Vault will use for locating and connecting to a database. Each
database driver type has a different syntax for its connection strings. database driver type has a different syntax for its connection strings.
> When using MySQL, make sure to append `?parseTime=true` to enable timestamp parsing. > When using MySQL, make sure to append `?parseTime=true` to enable timestamp parsing.
- `username`: `(string: <required>)` - - `username`: `(string: <required>)` -
@@ -1401,6 +1401,7 @@ snapshot began may or may not be included.
"continuation": "2F1nUpUKMZUBnwQ77qByt1" "continuation": "2F1nUpUKMZUBnwQ77qByt1"
} }
``` ```
### Sample Request ### Sample Request
```shell-session ```shell-session
@@ -1448,7 +1449,6 @@ into an `exportable` mode store and vice versa.
- `values` `([]string: <required>)` - - `values` `([]string: <required>)` -
Any number of tokenization state values from a previous snapshot call. Any number of tokenization state values from a previous snapshot call.
### Sample Payload ### Sample Payload
```json ```json
@@ -1460,6 +1460,7 @@ into an `exportable` mode store and vice versa.
] ]
} }
``` ```
### Sample Request ### Sample Request
```shell-session ```shell-session
@@ -1514,6 +1515,7 @@ snapshot began may or may not be included.
"continuation": "2F1nUpUKMZUBnwQ77qByt1" "continuation": "2F1nUpUKMZUBnwQ77qByt1"
} }
``` ```
### Sample Request ### Sample Request
```shell-session ```shell-session
@@ -1538,7 +1540,7 @@ $ curl \
{ {
"plaintext": "dmFsdWUtMg==", "plaintext": "dmFsdWUtMg==",
"token": "Q4tYgFXHxUNyMfqRW6fA82DYvMigwdf6JjATauyVzqx2SsmUShMhN5", "token": "Q4tYgFXHxUNyMfqRW6fA82DYvMigwdf6JjATauyVzqx2SsmUShMhN5",
"expiration_time": "2021-03-15T00:31:10Z", "expiration_time": "2021-03-15T00:31:10Z"
}, },
{ {
"plaintext": "dmFsdWUtMQ==", "plaintext": "dmFsdWUtMQ==",
@@ -1558,7 +1560,6 @@ new requests will be encoded with the new version of the key.
| :----- | :---------------------------------------------------- | | :----- | :---------------------------------------------------- |
| `POST` | `/transform/tokenization/keys/:transform_name/rotate` | | `POST` | `/transform/tokenization/keys/:transform_name/rotate` |
### Parameters ### Parameters
- `transform_name` `(string: <required>)` - `transform_name` `(string: <required>)`
@@ -1599,7 +1600,7 @@ Only valid for tokenization transformations.
```json ```json
[ [
{ {
"min_decryption_version": 1, "min_decryption_version": 1
} }
] ]
``` ```
@@ -1620,10 +1621,9 @@ List all tokenization keys.
Only valid for tokenization transformations. Only valid for tokenization transformations.
| Method | Path | | Method | Path |
| :----- | :------------------------------- | | :----- | :------------------------------ |
| `LIST` | `/transform/tokenization/keys/` | | `LIST` | `/transform/tokenization/keys/` |
### Sample Request ### Sample Request
```shell-session ```shell-session
@@ -1708,4 +1708,3 @@ $ curl \
--data @payload.json \ --data @payload.json \
http://127.0.0.1:8200/v1/transform//transform/tokenization/keys/:transform_name/trim http://127.0.0.1:8200/v1/transform//transform/tokenization/keys/:transform_name/trim
``` ```

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: Transit - Secrets Engines - HTTP API page_title: Transit - Secrets Engines - HTTP API
sidebar_title: Transit
description: This is the API documentation for the Vault Transit secrets engine. description: This is the API documentation for the Vault Transit secrets engine.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/audit-hash - HTTP API page_title: /sys/audit-hash - HTTP API
sidebar_title: <code>/sys/audit-hash</code>
description: |- description: |-
The `/sys/audit-hash` endpoint is used to hash data using an audit device's The `/sys/audit-hash` endpoint is used to hash data using an audit device's
hash function and salt. hash function and salt.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/audit - HTTP API page_title: /sys/audit - HTTP API
sidebar_title: <code>/sys/audit</code>
description: The `/sys/audit` endpoint is used to enable and disable audit devices. description: The `/sys/audit` endpoint is used to enable and disable audit devices.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/auth - HTTP API page_title: /sys/auth - HTTP API
sidebar_title: <code>/sys/auth</code>
description: The `/sys/auth` endpoint is used to manage auth methods in Vault. description: The `/sys/auth` endpoint is used to manage auth methods in Vault.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/capabilities-accessor - HTTP API page_title: /sys/capabilities-accessor - HTTP API
sidebar_title: <code>/sys/capabilities-accessor</code>
description: |- description: |-
The `/sys/capabilities-accessor` endpoint is used to fetch the capabilities of The `/sys/capabilities-accessor` endpoint is used to fetch the capabilities of
the token associated with an accessor, on the given paths. the token associated with an accessor, on the given paths.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/capabilities-self - HTTP API page_title: /sys/capabilities-self - HTTP API
sidebar_title: <code>/sys/capabilities-self</code>
description: |- description: |-
The `/sys/capabilities-self` endpoint is used to fetch the capabilities of The `/sys/capabilities-self` endpoint is used to fetch the capabilities of
client token on the given paths. client token on the given paths.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/capabilities - HTTP API page_title: /sys/capabilities - HTTP API
sidebar_title: <code>/sys/capabilities</code>
description: |- description: |-
The `/sys/capabilities` endpoint is used to fetch the capabilities of a token The `/sys/capabilities` endpoint is used to fetch the capabilities of a token
on the given paths. on the given paths.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/config/auditing - HTTP API page_title: /sys/config/auditing - HTTP API
sidebar_title: <code>/sys/config/auditing</code>
description: The `/sys/config/auditing` endpoint is used to configure auditing settings. description: The `/sys/config/auditing` endpoint is used to configure auditing settings.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/config/control-group - HTTP API page_title: /sys/config/control-group - HTTP API
sidebar_title: <code>/sys/config/control-group</code>
description: The '/sys/config/control-group' endpoint configures control groups. description: The '/sys/config/control-group' endpoint configures control groups.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/config/cors - HTTP API page_title: /sys/config/cors - HTTP API
sidebar_title: <code>/sys/config/cors</code>
description: >- description: >-
The '/sys/config/cors' endpoint configures how the Vault server responds to The '/sys/config/cors' endpoint configures how the Vault server responds to
cross-origin requests. cross-origin requests.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/config/state - HTTP API page_title: /sys/config/state - HTTP API
sidebar_title: <code>/sys/config/state</code>
description: The '/sys/config/state' endpoint is used to retrieve the configuration state. description: The '/sys/config/state' endpoint is used to retrieve the configuration state.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/config/ui - HTTP API page_title: /sys/config/ui - HTTP API
sidebar_title: <code>/sys/config/ui</code>
description: The '/sys/config/ui' endpoint configures the UI. description: The '/sys/config/ui' endpoint configures the UI.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/control-group - HTTP API page_title: /sys/control-group - HTTP API
sidebar_title: <code>/sys/control-group</code>
description: The '/sys/control-group' endpoint handles the Control Group workflow. description: The '/sys/control-group' endpoint handles the Control Group workflow.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/generate-recovery-token - HTTP API page_title: /sys/generate-recovery-token - HTTP API
sidebar_title: <code>/sys/generate-recovery-token</code>
description: |- description: |-
The `/sys/generate-recovery-token/` endpoints are used to create a new The `/sys/generate-recovery-token/` endpoints are used to create a new
recovery token for Vault. They are only active in recovery mode. recovery token for Vault. They are only active in recovery mode.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/generate-root - HTTP API page_title: /sys/generate-root - HTTP API
sidebar_title: <code>/sys/generate-root</code>
description: |- description: |-
The `/sys/generate-root/` endpoints are used to create a new root key for The `/sys/generate-root/` endpoints are used to create a new root key for
Vault. Vault.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/health - HTTP API page_title: /sys/health - HTTP API
sidebar_title: <code>/sys/health</code>
description: The `/sys/health` endpoint is used to check the health status of Vault. description: The `/sys/health` endpoint is used to check the health status of Vault.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/host-info - HTTP API page_title: /sys/host-info - HTTP API
sidebar_title: <code>/sys/host-info</code>
description: The '/sys/host-info' endpoint is used to retrieve host information description: The '/sys/host-info' endpoint is used to retrieve host information
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: System Backend - HTTP API page_title: System Backend - HTTP API
sidebar_title: System Backend
description: |- description: |-
The system backend is a default backend in Vault that is mounted at the `/sys` The system backend is a default backend in Vault that is mounted at the `/sys`
endpoint. This endpoint cannot be disabled or moved, and is used to configure endpoint. This endpoint cannot be disabled or moved, and is used to configure

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/init - HTTP API page_title: /sys/init - HTTP API
sidebar_title: <code>/sys/init</code>
description: The `/sys/init` endpoint is used to initialize a new Vault. description: The `/sys/init` endpoint is used to initialize a new Vault.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/internal/counters - HTTP API page_title: /sys/internal/counters - HTTP API
sidebar_title: <code>/sys/internal/counters</code>
description: >- description: >-
The `/sys/internal/counters` endpoints are used to return data about Vault usage. The `/sys/internal/counters` endpoints are used to return data about Vault usage.
--- ---
@@ -245,7 +244,7 @@ Note: the client count may be inaccurate in the moments following a Vault reboot
The estimate will stabilize when background loading of client data has completed. The estimate will stabilize when background loading of client data has completed.
| Method | Path | | Method | Path |
| :----- | :-------------------------------- | | :----- | :---------------------------------------- |
| `GET` | `/sys/internal/counters/activity/monthly` | | `GET` | `/sys/internal/counters/activity/monthly` |
### Sample Request ### Sample Request
@@ -268,7 +267,7 @@ $ curl \
"data": { "data": {
"distinct_entities": 100, "distinct_entities": 100,
"non_entity_tokens": 120, "non_entity_tokens": 120,
"clients": 220, "clients": 220
}, },
"wrap_info": null, "wrap_info": null,
"warnings": null, "warnings": null,

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/internal/specs/openapi - HTTP API page_title: /sys/internal/specs/openapi - HTTP API
sidebar_title: <code>/sys/internal/specs/openapi</code>
description: >- description: >-
The `/sys/internal/specs/openapi` endpoint is used to generate an OpenAPI The `/sys/internal/specs/openapi` endpoint is used to generate an OpenAPI
document of the mounted backends. document of the mounted backends.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/internal/ui/feature-flags - HTTP API page_title: /sys/internal/ui/feature-flags - HTTP API
sidebar_title: <code>/sys/internal/ui/feature-flags</code>
description: >- description: >-
The `/sys/internal/ui/feature-flags` endpoint exposes feature flags to the UI. The `/sys/internal/ui/feature-flags` endpoint exposes feature flags to the UI.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/internal/ui/mounts - HTTP API page_title: /sys/internal/ui/mounts - HTTP API
sidebar_title: <code>/sys/internal/ui/mounts</code>
description: >- description: >-
The `/sys/internal/ui/mounts` endpoint is used to manage mount listing The `/sys/internal/ui/mounts` endpoint is used to manage mount listing
visibility. visibility.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/key-status - HTTP API page_title: /sys/key-status - HTTP API
sidebar_title: <code>/sys/key-status</code>
description: |- description: |-
The `/sys/key-status` endpoint is used to query info about the current The `/sys/key-status` endpoint is used to query info about the current
encryption key of Vault. encryption key of Vault.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/leader - HTTP API page_title: /sys/leader - HTTP API
sidebar_title: <code>/sys/leader</code>
description: |- description: |-
The `/sys/leader` endpoint is used to check the high availability status and The `/sys/leader` endpoint is used to check the high availability status and
current leader of Vault. current leader of Vault.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/quotas/lease-count - HTTP API page_title: /sys/quotas/lease-count - HTTP API
sidebar_title: <code>/sys/quotas/lease-count</code>
description: The `/sys/quotas/lease-count` endpoint is used to create, edit and delete lease count quotas. description: The `/sys/quotas/lease-count` endpoint is used to create, edit and delete lease count quotas.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/leases - HTTP API page_title: /sys/leases - HTTP API
sidebar_title: <code>/sys/leases</code>
description: The `/sys/leases` endpoints are used to view and manage leases. description: The `/sys/leases` endpoints are used to view and manage leases.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/license - HTTP API page_title: /sys/license - HTTP API
sidebar_title: <code>/sys/license</code>
description: |- description: |-
The `/sys/license` endpoint is used to view and update the license used in The `/sys/license` endpoint is used to view and update the license used in
Vault. Vault.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/metrics - HTTP API page_title: /sys/metrics - HTTP API
sidebar_title: <code>/sys/metrics</code>
description: The `/sys/metrics` endpoint is used to get telemetry metrics for Vault. description: The `/sys/metrics` endpoint is used to get telemetry metrics for Vault.
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/mfa/method/duo - HTTP API page_title: /sys/mfa/method/duo - HTTP API
sidebar_title: <code>/sys/mfa/method/duo</code>
description: >- description: >-
The '/sys/mfa/method/duo' endpoint focuses on managing Duo MFA behaviors in The '/sys/mfa/method/duo' endpoint focuses on managing Duo MFA behaviors in
Vault Enterprise. Vault Enterprise.

View File

@@ -1,7 +1,6 @@
--- ---
layout: api layout: api
page_title: /sys/mfa - HTTP API page_title: /sys/mfa - HTTP API
sidebar_title: <code>/sys/mfa</code>
description: >- description: >-
The '/sys/mfa' endpoint focuses on managing MFA behaviors in Vault Enterprise The '/sys/mfa' endpoint focuses on managing MFA behaviors in Vault Enterprise
MFA. MFA.

Some files were not shown because too many files have changed in this diff Show More