/sys/internal/specs/openapi
The /sys/internal/specs/openapi
endpoint is used to generate an OpenAPI document of the mounted backends. The response conforms to the OpenAPI V3 specification, with path names matching the mount names used by the Vault server (i.e. customizations with -path
will be reflected). The set of included paths is based on the permissions of the request token.
The response may include Vault-specific extensions. Three are currently defined:
x-vault-sudo
- Endpoint requires sudo privileges.x-vault-unauthenticated
- Endpoint is unauthenticated.x-vault-create-supported
- Endpoint allows creation of new items, in addition to updating existing items.
Basic documentation will be generated for all paths, but a newer path definition structure now allows for more detailed documentation to be added. At this time the /sys
endpoints have been updated to use the new structure, and other endpoints will be modified incrementally.
Get OpenAPI document
This endpoint returns a single OpenAPI document describing all paths visible to the requester.
GET
/sys/internal/specs/openapi
Parameters
generic_mount_paths
(bool: false)
– Used to specify whether to use generic mount paths. If set, the mount paths will be replaced with a dynamic parameter:{mountPath}
Sample request
Sample response
Last updated