How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HashiCorp System API

The System API from HashiCorp — 107 operation(s) for system.

HashiCorp System API is one of 9 APIs that HashiCorp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include System. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 149 operations across 107 paths. It is described by OpenAPI 3.2.0, at version 1.9.3.

149 operations 107 paths 0 schemas 20 DELETE70 GET59 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.9.3
Resource Areas
1

Paths & Operations 149

Across 107 paths, the API surfaces 149 operations — 20 DELETE, 70 GET, 59 POST. Each is listed below with its method, path, parameters, and response codes.

System 149
GET
/sys/audit
HashiCorp List the enabled audit devices.
getSysAudit → 200
POST
/sys/audit-hash/{path}
HashiCorp The hash of the given string via the given audit backend
postSysAuditHashPath 1 param body → 200
POST
/sys/audit/{path}
HashiCorp Enable a new audit device at the supplied path.
postSysAuditPath 1 param body → 200
DELETE
/sys/audit/{path}
HashiCorp Disable the audit device at the given path.
deleteSysAuditPath 1 param → 204
GET
/sys/auth
HashiCorp List the currently enabled credential backends.
getSysAuth → 200
POST
/sys/auth/{path}
HashiCorp Enables a new auth method.
postSysAuthPath 1 param body → 200
DELETE
/sys/auth/{path}
HashiCorp Disable the auth method at the given auth path
deleteSysAuthPath 1 param → 204
GET
/sys/auth/{path}/tune
HashiCorp Reads the given auth path's configuration.
getSysAuthPathTune 1 param → 200
POST
/sys/auth/{path}/tune
HashiCorp Tune configuration parameters for a given auth path.
postSysAuthPathTune 1 param body → 200
POST
/sys/capabilities
HashiCorp Fetches the capabilities of the given token on the given path.
postSysCapabilities body → 200
POST
/sys/capabilities-accessor
HashiCorp Fetches the capabilities of the token associated with the given token, on the given path.
postSysCapabilitiesAccessor body → 200
POST
/sys/capabilities-self
HashiCorp Fetches the capabilities of the given token on the given path.
postSysCapabilitiesSelf body → 200
GET
/sys/config/auditing/request-headers
HashiCorp List the request headers that are configured to be audited.
getSysConfigAuditingRequestHeaders → 200
GET
/sys/config/auditing/request-headers/{header}
HashiCorp List the information for the given request header.
getSysConfigAuditingRequestHeadersHeader 1 param → 200
POST
/sys/config/auditing/request-headers/{header}
HashiCorp Enable auditing of a header.
postSysConfigAuditingRequestHeadersHeader 1 param body → 200
DELETE
/sys/config/auditing/request-headers/{header}
HashiCorp Disable auditing of the given request header.
deleteSysConfigAuditingRequestHeadersHeader 1 param → 204
GET
/sys/config/cors
HashiCorp Return the current CORS settings.
getSysConfigCors → 200
POST
/sys/config/cors
HashiCorp Configure the CORS settings.
postSysConfigCors body → 200
DELETE
/sys/config/cors
HashiCorp Remove any CORS settings.
deleteSysConfigCors → 204
POST
/sys/config/reload/{subsystem}
HashiCorp Reload the given subsystem
postSysConfigReloadSubsystem 1 param → 200
GET
/sys/config/state/sanitized
HashiCorp Return a sanitized version of the Vault server configuration.
getSysConfigStateSanitized → 200
GET
/sys/config/ui/headers/
HashiCorp Return a list of configured UI headers.
getSysConfigUiHeaders 1 param → 200
GET
/sys/config/ui/headers/{header}
HashiCorp Return the given UI header's configuration
getSysConfigUiHeadersHeader 1 param → 200
POST
/sys/config/ui/headers/{header}
HashiCorp Configure the values to be returned for the UI header.
postSysConfigUiHeadersHeader 1 param body → 200
DELETE
/sys/config/ui/headers/{header}
HashiCorp Remove a UI header.
deleteSysConfigUiHeadersHeader 1 param → 204
GET
/sys/generate-root
HashiCorp Read the configuration and progress of the current root generation attempt.
getSysGenerateRoot → 200
POST
/sys/generate-root
HashiCorp Initializes a new root generation attempt.
postSysGenerateRoot body → 200
DELETE
/sys/generate-root
HashiCorp Cancels any in-progress root generation attempt.
deleteSysGenerateRoot → 204
GET
/sys/generate-root/attempt
HashiCorp Read the configuration and progress of the current root generation attempt.
getSysGenerateRootAttempt → 200
POST
/sys/generate-root/attempt
HashiCorp Initializes a new root generation attempt.
postSysGenerateRootAttempt body → 200
DELETE
/sys/generate-root/attempt
HashiCorp Cancels any in-progress root generation attempt.
deleteSysGenerateRootAttempt → 204
POST
/sys/generate-root/update
HashiCorp Enter a single master key share to progress the root generation attempt.
postSysGenerateRootUpdate body → 200
GET
/sys/health
HashiCorp Returns the health status of Vault.
getSysHealth → 200429472501503
GET
/sys/host-info
HashiCorp Information about the host instance that this Vault server is running on.
getSysHostInfo → 200
GET
/sys/init
HashiCorp Returns the initialization status of Vault.
getSysInit → 200
POST
/sys/init
HashiCorp Initialize a new Vault.
postSysInit body → 200
GET
/sys/internal/counters/activity
HashiCorp Report the client count metrics, for this namespace and all child namespaces.
getSysInternalCountersActivity → 200
GET
/sys/internal/counters/activity/monthly
HashiCorp Report the number of clients for this month, for this namespace and all child namespaces.
getSysInternalCountersActivityMonthly → 200
GET
/sys/internal/counters/config
HashiCorp Read the client count tracking configuration.
getSysInternalCountersConfig → 200
POST
/sys/internal/counters/config
HashiCorp Enable or disable collection of client count, set retention period, or set default reporting period.
postSysInternalCountersConfig body → 200
GET
/sys/internal/counters/entities
HashiCorp Backwards compatibility is not guaranteed for this API
getSysInternalCountersEntities → 200
GET
/sys/internal/counters/requests
HashiCorp Backwards compatibility is not guaranteed for this API
getSysInternalCountersRequests → 200
GET
/sys/internal/counters/tokens
HashiCorp Backwards compatibility is not guaranteed for this API
getSysInternalCountersTokens → 200
GET
/sys/internal/specs/openapi
HashiCorp Generate an OpenAPI 3 document of all mounted paths.
getSysInternalSpecsOpenapi → 200
GET
/sys/internal/ui/feature-flags
HashiCorp Lists enabled feature flags.
getSysInternalUiFeatureFlags → 200
GET
/sys/internal/ui/mounts
HashiCorp Lists all enabled and visible auth and secrets mounts.
getSysInternalUiMounts → 200
GET
/sys/internal/ui/mounts/{path}
HashiCorp Return information about the given mount.
getSysInternalUiMountsPath 1 param → 200
GET
/sys/internal/ui/namespaces
HashiCorp Backwards compatibility is not guaranteed for this API
getSysInternalUiNamespaces → 200
GET
/sys/internal/ui/resultant-acl
HashiCorp Backwards compatibility is not guaranteed for this API
getSysInternalUiResultantAcl → 200
GET
/sys/key-status
HashiCorp Provides information about the backend encryption key.
getSysKeyStatus → 200
GET
/sys/leader
HashiCorp Returns the high availability status and current leader instance of Vault.
getSysLeader → 200
GET
/sys/leases
HashiCorp List leases associated with this Vault cluster
getSysLeases → 200
GET
/sys/leases/count
HashiCorp Count of leases associated with this Vault cluster
getSysLeasesCount → 200
POST
/sys/leases/lookup
HashiCorp Retrieve lease metadata.
postSysLeasesLookup body → 200
GET
/sys/leases/lookup/
HashiCorp Returns a list of lease ids.
getSysLeasesLookup 1 param → 200
GET
/sys/leases/lookup/{prefix}
HashiCorp Returns a list of lease ids.
getSysLeasesLookupPrefix 2 params → 200
POST
/sys/leases/renew
HashiCorp Renews a lease, requesting to extend the lease.
postSysLeasesRenew body → 200
POST
/sys/leases/renew/{url_lease_id}
HashiCorp Renews a lease, requesting to extend the lease.
postSysLeasesRenewUrl_lease_id 1 param body → 200
POST
/sys/leases/revoke
HashiCorp Revokes a lease immediately.
postSysLeasesRevoke body → 200
POST
/sys/leases/revoke-force/{prefix}
HashiCorp Revokes all secrets or tokens generated under a given prefix immediately
postSysLeasesRevokeForcePrefix 1 param → 200
POST
/sys/leases/revoke-prefix/{prefix}
HashiCorp Revokes all secrets (via a lease ID prefix) or tokens (via the tokens' path property) generated under a given prefix immediately.
postSysLeasesRevokePrefixPrefix 1 param body → 200
POST
/sys/leases/revoke/{url_lease_id}
HashiCorp Revokes a lease immediately.
postSysLeasesRevokeUrl_lease_id 1 param body → 200
POST
/sys/leases/tidy
HashiCorp This endpoint performs cleanup tasks that can be run if certain error conditions have occurred.
postSysLeasesTidy → 200
GET
/sys/metrics
HashiCorp Export the metrics aggregated for telemetry purpose.
getSysMetrics 1 param → 200
GET
/sys/monitor
getSysMonitor 1 param → 200
GET
/sys/mounts
HashiCorp List the currently mounted backends.
getSysMounts → 200
POST
/sys/mounts/{path}
HashiCorp Enable a new secrets engine at the given path.
postSysMountsPath 1 param body → 200
DELETE
/sys/mounts/{path}
HashiCorp Disable the mount point specified at the given path.
deleteSysMountsPath 1 param → 204
GET
/sys/mounts/{path}/tune
HashiCorp Tune backend configuration parameters for this mount.
getSysMountsPathTune 1 param → 200
POST
/sys/mounts/{path}/tune
HashiCorp Tune backend configuration parameters for this mount.
postSysMountsPathTune 1 param body → 200
GET
/sys/plugins/catalog
HashiCorp Lists all the plugins known to Vault
getSysPluginsCatalog → 200
GET
/sys/plugins/catalog/{name}
HashiCorp Return the configuration data for the plugin with the given name.
getSysPluginsCatalogName 1 param → 200
POST
/sys/plugins/catalog/{name}
HashiCorp Register a new plugin, or updates an existing one with the supplied name.
postSysPluginsCatalogName 1 param body → 200
DELETE
/sys/plugins/catalog/{name}
HashiCorp Remove the plugin with the given name.
deleteSysPluginsCatalogName 1 param → 204
GET
/sys/plugins/catalog/{type}
HashiCorp List the plugins in the catalog.
getSysPluginsCatalogType 2 params → 200
GET
/sys/plugins/catalog/{type}/{name}
HashiCorp Return the configuration data for the plugin with the given name.
getSysPluginsCatalogTypeName 2 params → 200
POST
/sys/plugins/catalog/{type}/{name}
HashiCorp Register a new plugin, or updates an existing one with the supplied name.
postSysPluginsCatalogTypeName 2 params body → 200
DELETE
/sys/plugins/catalog/{type}/{name}
HashiCorp Remove the plugin with the given name.
deleteSysPluginsCatalogTypeName 2 params → 204
POST
/sys/plugins/reload/backend
HashiCorp Reload mounted plugin backends.
postSysPluginsReloadBackend body → 200
GET
/sys/policies/acl
HashiCorp List the configured access control policies.
getSysPoliciesAcl 1 param → 200
GET
/sys/policies/acl/{name}
HashiCorp Retrieve information about the named ACL policy.
getSysPoliciesAclName 1 param → 200
POST
/sys/policies/acl/{name}
HashiCorp Add a new or update an existing ACL policy.
postSysPoliciesAclName 1 param body → 200
DELETE
/sys/policies/acl/{name}
HashiCorp Delete the ACL policy with the given name.
deleteSysPoliciesAclName 1 param → 204
GET
/sys/policies/password/{name}
HashiCorp Retrieve an existing password policy.
getSysPoliciesPasswordName 1 param → 200
POST
/sys/policies/password/{name}
HashiCorp Add a new or update an existing password policy.
postSysPoliciesPasswordName 1 param body → 200
DELETE
/sys/policies/password/{name}
HashiCorp Delete a password policy.
deleteSysPoliciesPasswordName 1 param → 204
GET
/sys/policies/password/{name}/generate
HashiCorp Generate a password from an existing password policy.
getSysPoliciesPasswordNameGenerate 1 param → 200
GET
/sys/policy
HashiCorp List the configured access control policies.
getSysPolicy 1 param → 200
GET
/sys/policy/{name}
HashiCorp Retrieve the policy body for the named policy.
getSysPolicyName 1 param → 200
POST
/sys/policy/{name}
HashiCorp Add a new or update an existing policy.
postSysPolicyName 1 param body → 200
DELETE
/sys/policy/{name}
HashiCorp Delete the policy with the given name.
deleteSysPolicyName 1 param → 204
GET
/sys/pprof/
HashiCorp Returns an HTML page listing the available profiles.
getSysPprof → 200
GET
/sys/pprof/allocs
HashiCorp Returns a sampling of all past memory allocations.
getSysPprofAllocs → 200
GET
/sys/pprof/block
HashiCorp Returns stack traces that led to blocking on synchronization primitives
getSysPprofBlock → 200
GET
/sys/pprof/cmdline
HashiCorp Returns the running program's command line.
getSysPprofCmdline → 200
GET
/sys/pprof/goroutine
HashiCorp Returns stack traces of all current goroutines.
getSysPprofGoroutine → 200
GET
/sys/pprof/heap
HashiCorp Returns a sampling of memory allocations of live object.
getSysPprofHeap → 200
GET
/sys/pprof/mutex
HashiCorp Returns stack traces of holders of contended mutexes
getSysPprofMutex → 200
GET
/sys/pprof/profile
HashiCorp Returns a pprof-formatted cpu profile payload.
getSysPprofProfile → 200
GET
/sys/pprof/symbol
HashiCorp Returns the program counters listed in the request.
getSysPprofSymbol → 200
GET
/sys/pprof/threadcreate
HashiCorp Returns stack traces that led to the creation of new OS threads
getSysPprofThreadcreate → 200
GET
/sys/pprof/trace
HashiCorp Returns the execution trace in binary form.
getSysPprofTrace → 200
GET
/sys/quotas/config
getSysQuotasConfig → 200
POST
/sys/quotas/config
postSysQuotasConfig body → 200
GET
/sys/quotas/rate-limit
getSysQuotasRateLimit 1 param → 200
GET
/sys/quotas/rate-limit/{name}
getSysQuotasRateLimitName 1 param → 200
POST
/sys/quotas/rate-limit/{name}
postSysQuotasRateLimitName 1 param body → 200
DELETE
/sys/quotas/rate-limit/{name}
deleteSysQuotasRateLimitName 1 param → 204
GET
/sys/raw
HashiCorp Read the value of the key at the given path.
getSysRaw 1 param → 200
POST
/sys/raw
HashiCorp Update the value of the key at the given path.
postSysRaw body → 200
DELETE
/sys/raw
HashiCorp Delete the key with given path.
deleteSysRaw → 204
GET
/sys/raw/{path}
HashiCorp Read the value of the key at the given path.
getSysRawPath 2 params → 200
POST
/sys/raw/{path}
HashiCorp Update the value of the key at the given path.
postSysRawPath 1 param body → 200
DELETE
/sys/raw/{path}
HashiCorp Delete the key with given path.
deleteSysRawPath 1 param → 204
GET
/sys/rekey/backup
HashiCorp Return the backup copy of PGP-encrypted unseal keys.
getSysRekeyBackup → 200
DELETE
/sys/rekey/backup
HashiCorp Delete the backup copy of PGP-encrypted unseal keys.
deleteSysRekeyBackup → 204
GET
/sys/rekey/init
HashiCorp Reads the configuration and progress of the current rekey attempt.
getSysRekeyInit → 200
POST
/sys/rekey/init
HashiCorp Initializes a new rekey attempt.
postSysRekeyInit body → 200
DELETE
/sys/rekey/init
HashiCorp Cancels any in-progress rekey.
deleteSysRekeyInit → 204
GET
/sys/rekey/recovery-key-backup
HashiCorp Allows fetching or deleting the backup of the rotated unseal keys.
getSysRekeyRecoveryKeyBackup → 200
DELETE
/sys/rekey/recovery-key-backup
HashiCorp Allows fetching or deleting the backup of the rotated unseal keys.
deleteSysRekeyRecoveryKeyBackup → 204
POST
/sys/rekey/update
HashiCorp Enter a single master key share to progress the rekey of the Vault.
postSysRekeyUpdate body → 200
GET
/sys/rekey/verify
HashiCorp Read the configuration and progress of the current rekey verification attempt.
getSysRekeyVerify → 200
POST
/sys/rekey/verify
HashiCorp Enter a single new key share to progress the rekey verification operation.
postSysRekeyVerify body → 200
DELETE
/sys/rekey/verify
HashiCorp Cancel any in-progress rekey verification operation.
deleteSysRekeyVerify → 204
POST
/sys/remount
HashiCorp Move the mount point of an already-mounted backend.
postSysRemount body → 200
POST
/sys/renew
HashiCorp Renews a lease, requesting to extend the lease.
postSysRenew body → 200
POST
/sys/renew/{url_lease_id}
HashiCorp Renews a lease, requesting to extend the lease.
postSysRenewUrl_lease_id 1 param body → 200
GET
/sys/replication/status
getSysReplicationStatus → 200
POST
/sys/revoke
HashiCorp Revokes a lease immediately.
postSysRevoke body → 200
POST
/sys/revoke-force/{prefix}
HashiCorp Revokes all secrets or tokens generated under a given prefix immediately
postSysRevokeForcePrefix 1 param → 200
POST
/sys/revoke-prefix/{prefix}
HashiCorp Revokes all secrets (via a lease ID prefix) or tokens (via the tokens' path property) generated under a given prefix immediately.
postSysRevokePrefixPrefix 1 param body → 200
POST
/sys/revoke/{url_lease_id}
HashiCorp Revokes a lease immediately.
postSysRevokeUrl_lease_id 1 param body → 200
POST
/sys/rotate
HashiCorp Rotates the backend encryption key used to persist data.
postSysRotate → 200
GET
/sys/rotate/config
getSysRotateConfig → 200
POST
/sys/rotate/config
postSysRotateConfig body → 200
POST
/sys/seal
HashiCorp Seal the Vault.
postSysSeal → 200
GET
/sys/seal-status
HashiCorp Check the seal status of a Vault.
getSysSealStatus → 200
POST
/sys/step-down
HashiCorp Cause the node to give up active status.
postSysStepDown → 204
POST
/sys/tools/hash
HashiCorp Generate a hash sum for input data
postSysToolsHash body → 200
POST
/sys/tools/hash/{urlalgorithm}
HashiCorp Generate a hash sum for input data
postSysToolsHashUrlalgorithm 1 param body → 200
POST
/sys/tools/random
HashiCorp Generate random bytes
postSysToolsRandom body → 200
POST
/sys/tools/random/{urlbytes}
HashiCorp Generate random bytes
postSysToolsRandomUrlbytes 1 param body → 200
POST
/sys/unseal
HashiCorp Unseal the Vault.
postSysUnseal body → 200
GET
/sys/wrapping/lookup
HashiCorp Look up wrapping properties for the requester's token.
getSysWrappingLookup → 200
POST
/sys/wrapping/lookup
HashiCorp Look up wrapping properties for the given token.
postSysWrappingLookup body → 200
POST
/sys/wrapping/rewrap
HashiCorp Rotates a response-wrapped token.
postSysWrappingRewrap body → 200
POST
/sys/wrapping/unwrap
HashiCorp Unwraps a response-wrapped token.
postSysWrappingUnwrap body → 200
POST
/sys/wrapping/wrap
HashiCorp Response-wraps an arbitrary JSON object.
postSysWrappingWrap → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hashicorp-system-api-openapi.yml Raw ↑

Other APIs HashiCorp publishes across the network.

HashiCorp Terraform
HashiCorp Nomad
HashiCorp Consul
HashiCorp Boundary
HashiCorp Vagrant
HashiCorp Auth API
HashiCorp Identity API
HashiCorp Secrets API
Where this information came from

This is an independent, third-party profile of HashiCorp System API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.