Virtual HSM
Home
  • Virtual HSM
  • Documentation
    • What is Virtual HSM?
    • Use Case: Attested Secret Provisioning in the Cloud
    • Setup
      • Install
      • vHSM Server Configuration
        • Parameters
        • vHSM Telemetry Parameters
      • vHSM Agent
        • Agent Configuration
      • vHSM Proxy
        • Proxy Configuration
    • Get Started
      • Start the Vault server
      • MariaDB root admin password provisioning on Azure DCXas_v5 VM
    • Supported Cloud Configurations
  • Tutorials
    • Deploying the vhsm Container on an EC2 Instance
    • CLI quickstart
    • vHSM Agent quickstart
    • vHSM Proxy quickstart
    • Passing vHSM secrets using ConfigMaps
    • Provisioning MariaDB Password on Azure DCXas_v5 VM
    • Registering a buckypaper plugin
    • Monitoring vHSM with Grafana
  • Integration with Utimaco SecurityServer
    • Integrate enclaive vHSM with Utimaco HSM
  • API
    • Auth
    • Default
    • Secrets
    • System
    • Identity
    • Models
  • vHSM CLI
    • Server and Infrastructure Management
      • vhsm server
      • vhsm proxy
      • vhsm monitor
      • vhsm status
      • vhsm agent
    • Secret Management
      • vhsm read
      • vhsm write
      • vhsm delete
      • vhsm list
      • vhsm secrets
        • vhsm secrets enable
        • vhsm secrets disable
        • vhsm secrets list
        • vhsm secrets move
        • vhsm secrets tune
      • vhsm unwrap
    • Configuration and Management
      • vhsm plugin
        • vhsm plugin info
        • vhsm plugin deregister
        • vhsm plugin list
        • vhsm plugin register
        • vhsm plugin reload
        • vhsm plugin reload-status
      • vhsm namespace
      • vhsm operator
      • vhsm print
      • vhsm path-help
      • vhsm lease
    • Auditing and Debugging
      • vhsm audit
      • vhsm debug
    • Attestation
    • Security and Encryption
      • vhsm pki
        • vhsm pki health-check
        • vhsm pki issue
        • vhsm pki list-intermediates
        • vhsm pki reissue
        • vhsm pki verify-sign
      • vhsm transit
      • vhsm ssh
      • vhsm transform
    • Authentication and Authorization
      • vhsm login
      • vhsm auth
      • vhsm token
      • vhsm policy
    • Storage and Data Mangement
      • vhsm kv
      • vhsm patch
    • vhsm version
      • vhsm version-history
  • Troubleshooting
    • CA Validity Period
    • CRL Validity Period
    • Root Certificate Issued Non-CA Leaves
    • Role Allows Implicit Localhost Issuance
    • Role Allows Glob-Based Wildcard Issuance
    • Performance Impact
    • Accessibility of Audit Information
    • Allow If-Modified-Since Requests
    • Auto-Tidy Disabled
    • Tidy Hasn't Run
    • Too Many Certificates
    • Enable ACME Issuance
    • ACME Response Headers Configuration
  • Resources
    • Community
    • GitHub
    • Youtube
    • CCx101 wiki
Powered by GitBook
On this page

Was this helpful?

  1. API

Secrets

PreviousDefaultNextSystem

Was this helpful?

Deletes the secret at the specified location.

delete
Path parameters
pathstringRequired

Specifies the path of the secret.

Responses
204
Secret deleted successfully. No content is returned.
403
Permission denied.
application/json
404
Secret not found.
application/json
delete
DELETE /v1/cubbyhole/{path} HTTP/1.1
Host: localhost:8200
Accept: */*

No content

  • GETRetrieve the secret at the specified location.
  • POSTStore a secret at the specified location.
  • DELETEDeletes the secret at the specified location.

Retrieve the secret at the specified location.

get
Path parameters
pathstringRequired

Specifies the path of the secret.

Query parameters
liststringOptional

Return a list if true.

Responses
200
Secret retrieved successfully.
application/json
403
Permission denied.
application/json
404
Secret not found.
application/json
get
GET /v1/cubbyhole/{path} HTTP/1.1
Host: localhost:8200
Accept: */*
{
  "request_id": "abcd-1234",
  "lease_id": "",
  "renewable": false,
  "lease_duration": 0,
  "data": {
    "foo": "bar"
  },
  "wrap_info": null,
  "warnings": null,
  "auth": null
}

Store a secret at the specified location.

post
Path parameters
pathstringRequired

Specifies the path of the secret.

Body
anyOptional
Responses
200
Secret written successfully.
application/json
400
Bad request.
application/json
403
Permission denied.
application/json
post
POST /v1/cubbyhole/{path} HTTP/1.1
Host: localhost:8200
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "foo": "bar"
}
{
  "request_id": "abcd-5678",
  "lease_id": "",
  "renewable": false,
  "lease_duration": 0,
  "data": null,
  "wrap_info": null,
  "warnings": null,
  "auth": null
}