REST API Reference
Vault Projects API
Create, list, inspect, and configure tenant vault projects. Projects are the top-level container encapsulating environments, policies, and service accounts.
Create Project
Initializes a new vault project for an application or cluster. Automatically provisions default production and development environments.
Create Vault ProjectAuth
Provision a new vault project container.
Payload Example
{
"name": "billing-engine",
"description": "Secrets for payment and subscription services",
"tags": ["tier-1", "pci-dss"]
}Status Codes
- Name
201- Type
- HTTP
- Description
- Project provisioned with default stages.
- Name
400- Type
- HTTP
- Description
- Project name is missing or invalid slug syntax.
- Name
403- Type
- HTTP
- Description
- Insufficient tenant quota to create additional projects.
Request Parameters
- Name
name- Type
- string
- Required
- Description
- Unique alphanumeric name/slug for the project.
- Name
description- Type
- string
- Description
- Human-readable description of project purpose.
- Name
tags- Type
- string[]
- Description
- Array of organizational metadata tags.
Request
POST/v1/secrets/projects
Response 201
List Projects
Returns all vault projects accessible to the authenticated tenant user or service account.
List ProjectsAuth
Enumerate all projects with environment counts.
Status Codes
- Name
200- Type
- HTTP
- Description
- Successfully retrieved list of projects.
Request
GET/v1/secrets/projects
Response 200