Vault V1 Folders API Reference

post/v1/folder/create

curl -sSLX POST 'https://vault.aws.us.pangea.cloud/v1/folder/create' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

Create a folder

POST

https://vault.aws.us.pangea.cloud/v1/folder/create

Create a folder in Vault.

required parameters

name

string

Name of a folder

folder

string

Parent folder where this folder is stored

optional parameters

metadata

object

Metadata provided by the user

array<string>

List of user-defined tags

rotation_frequency

string (pangea-duration)

Time interval between item rotations, provided as a positive number followed by a time unit: secs, mins, hrs, days, weeks, months, or years. You can use abbreviations like 1d. Omit to inherit from the parent folder or default settings. Set to never to disable rotation.

rotation_state

string

Target state for the previous version of the folder items after rotation. Set to inherited to inherit from the parent folder or default settings.

rotation_state

rotation_grace_period

string (pangea-duration)

Grace period for the previous version, provided as a positive number followed by a time unit: secs, mins, hrs, days, weeks, months, or years. You can use abbreviations like 1d. Omit to inherit from the parent folder or default settings.

expiration

string (date-time-or-never)

Expiration timestamp (in iso8601), never to disable expiration

Response Fields

Response Schema

object

Pangea standard response schema

result

object

string (pangea-id)

ID of a Vault key, secret, token, or folder

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Was this article helpful?