vault/website/content/api-docs/system
Marc Boudreau dcde458e33
VAULT-23051: Documenting API Endpoints (#24845)
* api documentation changes

* document management endpoints

* add new website page to the navigation

* include explanation message retrieval from namespaces up to root namespace

* added clarification statement to the create and update operations documentation

* fixed inconsistency in sample request

* Apply suggestions from code review

Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com>

---------

Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com>
2024-01-19 16:13:03 -05:00
..
inspect [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
mfa [DOCS] Confirm restricted endpoint alerts (main) (#23514) 2023-10-05 13:00:40 -04:00
replication Update enterprise vs hcp alerts (#23619) 2023-10-11 17:59:27 -05:00
storage Update enterprise vs hcp alerts (#23619) 2023-10-11 17:59:27 -05:00
audit-hash.mdx [DOCS] Confirm restricted endpoint alerts (main) (#23514) 2023-10-05 13:00:40 -04:00
audit.mdx Update audit.mdx (#24561) 2023-12-19 18:10:53 +00:00
auth.mdx typo corrections - spelling and grammar (#24625) 2024-01-04 12:50:42 -05:00
capabilities-accessor.mdx [docs] Convert titles to sentense case (#21426) 2023-06-30 19:22:07 -04:00
capabilities-self.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
capabilities.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
config-auditing.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
config-control-group.mdx Update enterprise vs hcp alerts (#23619) 2023-10-11 17:59:27 -05:00
config-cors.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
config-group-policy-application.mdx Update enterprise vs hcp alerts (#23619) 2023-10-11 17:59:27 -05:00
config-reload.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
config-state.mdx Remove asterixes in header (#23548) 2023-10-09 13:03:54 -07:00
config-ui-custom-messages.mdx VAULT-23051: Documenting API Endpoints (#24845) 2024-01-19 16:13:03 -05:00
config-ui-headers.mdx VAULT-23051: Documenting API Endpoints (#24845) 2024-01-19 16:13:03 -05:00
control-group.mdx Update enterprise vs hcp alerts (#23619) 2023-10-11 17:59:27 -05:00
decode-token.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
experiments.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
generate-recovery-token.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
generate-root.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
ha-status.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
health.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
host-info.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
in-flight-req.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
index.mdx [docs] Convert titles to sentense case (#21426) 2023-06-30 19:22:07 -04:00
init.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
internal-counters.mdx Add method and path for Read the client count configuration (#23551) 2023-10-12 10:10:04 -04:00
internal-specs-openapi.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
internal-ui-authenticated-messages.mdx VAULT-23051: Documenting API Endpoints (#24845) 2024-01-19 16:13:03 -05:00
internal-ui-feature.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
internal-ui-mounts.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
internal-ui-namespaces.mdx [docs] Convert titles to sentense case (#21426) 2023-06-30 19:22:07 -04:00
internal-ui-resultant-acl.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
internal-ui-unauthenticated-messages.mdx VAULT-23051: Documenting API Endpoints (#24845) 2024-01-19 16:13:03 -05:00
internal-ui-version.mdx VAULT-20669: Add New Authenticated Endpoint for Version (#23740) 2023-10-26 12:52:52 -04:00
key-status.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
leader.mdx update /sys/leader api docs (#24816) 2024-01-11 13:27:53 -06:00
lease-count-quotas.mdx Docs changes (#24242) 2024-01-05 15:31:16 -08:00
leases.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
license.mdx Update enterprise vs hcp alerts (#23619) 2023-10-11 17:59:27 -05:00
loggers.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
managed-keys.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
metrics.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
monitor.mdx [DOCS] Confirm restricted endpoint alerts (main) (#23514) 2023-10-05 13:00:40 -04:00
mounts.mdx typo corrections - spelling and grammar (#24625) 2024-01-04 12:50:42 -05:00
namespaces.mdx [docs] Convert titles to sentense case (#21426) 2023-06-30 19:22:07 -04:00
plugins-catalog.mdx add API docs for plugin runtimes (#23223) 2023-09-28 05:35:22 +00:00
plugins-reload.mdx New root namespace plugin reload API sys/plugins/reload/:type/:name (#24878) 2024-01-17 15:46:27 +00:00
plugins-runtimes-catalog.mdx Support rootless plugin containers (#24236) 2023-11-28 14:07:07 +00:00
policies-password.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
policies.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
policy.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
pprof.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
quotas-config.mdx Docs changes (#24242) 2024-01-05 15:31:16 -08:00
rate-limit-quotas.mdx Docs changes (#24242) 2024-01-05 15:31:16 -08:00
raw.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
rekey-recovery-key.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
rekey.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
remount.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
rotate-config.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
rotate.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
seal-backend-status.mdx First draft of Seal HA documentation (#23252) 2023-09-22 13:18:48 -05:00
seal-status.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
seal.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
sealwrap-rewrap.mdx Update enterprise vs hcp alerts (#23619) 2023-10-11 17:59:27 -05:00
secrets-sync.mdx small doc fix (#24720) 2024-01-09 13:47:34 -08:00
step-down.mdx Update step-down.mdx to describe behavior against non-active nodes (#23657) 2023-10-18 19:33:46 -07:00
tools.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
unseal.mdx [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
user-lockout.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
version-history.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
wrapping-lookup.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
wrapping-rewrap.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
wrapping-unwrap.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
wrapping-wrap.mdx Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00