Vault V2 Secrets API Reference

post/v2/secret/rotate

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

Response

Raw Output

Rotate secret

POST

https://vault.aws.us.pangea.cloud/v2/secret/rotate

Rotate a Vault secret or token

required parameters

id

string (pangea-id)

ID of a secret

id

secret

string

Secret value

optional parameters

rotation_state

string

Target state for the previous version after rotation. Omit to apply the current rotation policy.

rotation_state

Response Fields

Response Schema

object

Pangea standard response schema

result

id

string

ID of the secret

type

string

Type of the Vault item

item_versions

array<object>

version

integer

Item version

created_at

string (date-time)

Timestamp indicating when this version was created

state

string

State of the item version

destroyed_at

string (date-time)

Timestamp indicating when this version will be destroyed

rotated_at

string (date-time)

Timestamp of the last rotation

secret

string

Secret value

metadata

object

Metadata provided by the user

num_versions

integer

Total number of versions of the item

enabled

boolean

true if the item is enabled

name

string

Name of the item

folder

string

Folder where the item is stored

array<string>

List of user-defined tags

last_rotated

string (date-time)

Timestamp of the last rotation

next_rotation

string (date-time)

Timestamp of the next rotation if auto-rotation is enabled

disabled_at

string (date-time)

Timestamp indicating when the item will be disabled

created_at

string (date-time)

Timestamp indicating when the item was created

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.

post/v2/secret/store

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

Response

Raw Output

Store secret

POST

https://vault.aws.us.pangea.cloud/v2/secret/store

Store a secret or token as a Vault item.

required parameters

secret

string

Secret value

minLength: 1
maxLength: 10,240

optional parameters

type

name

string

Name of the item

folder

string

Folder where the item is stored

metadata

object

Metadata provided by the user

array<string>

List of user-defined tags

disabled_at

string (date-time)

Timestamp indicating when the item will be disabled

Response Fields

Response Schema

object

Pangea standard response schema

result

id

string

ID of the secret

type

string

Type of the Vault item

item_versions

array<object>

version

integer

Item version

created_at

string (date-time)

Timestamp indicating when this version was created

state

string

State of the item version

destroyed_at

string (date-time)

Timestamp indicating when this version will be destroyed

rotated_at

string (date-time)

Timestamp of the last rotation

secret

string

Secret value

metadata

object

Metadata provided by the user

num_versions

integer

Total number of versions of the item

enabled

boolean

true if the item is enabled

name

string

Name of the item

folder

string

Folder where the item is stored

array<string>

List of user-defined tags

last_rotated

string (date-time)

Timestamp of the last rotation

next_rotation

string (date-time)

Timestamp of the next rotation if auto-rotation is enabled

disabled_at

string (date-time)

Timestamp indicating when the item will be disabled

created_at

string (date-time)

Timestamp indicating when the item was created

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?

Contact us