Skip to main content

Introduction

The Piiano Vault REST API enables you to access and manage collections, objects, tokens, users, policies, and other resources within Piiano Vault in a simple, programmatic way using conventional HTTP requests and standard HTTP response codes.

The API follows RESTful conventions when possible, with most operations performed by GET, POST, PUT, PATCH, and DELETE requests. Request and response bodies are JSON-encoded. However, for collection operations, an SQL-like PVSchema encoding is available.

This API reference provides details for each operation available in the API.

When you install a local copy of Vault, you can try each operation using Send API request.

An OpenAPI specification is available in YAML and JSON formats and can be used to generate client code for the API.