Skip to main content

Vault V1 General API Reference

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

Response

Get Vault item

POST
https://vault.aws.us.pangea.cloud/v1/get

Retrieve details for a key, secret, token, or folder.

required parameters

string (pangea-id)

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

string, integer

Version(s) to retrieve. Supported parameter values are:

  • all - Retrieve all versions of the item.
  • <num> - Retrieve a specific version number of the item.
  • -<num> - Retrieve last <num> + 1 versions of the item.
  • <no-value> - Return the current version.
string

Filter based on version state.

boolean
(default: false)

Return metadata and extra fields

object

Pangea standard response schema

string

ID of the key

string

Type of the Vault item

string

State of the item

object

Metadata about an item version

integer

Item version

string (date-time)

Timestamp indicating when this version was created

string

State of the item version

string (date-time)

Timestamp indicating when this version will be destroyed

string

Public key (in PEM format)

string

Name of the item

string

Folder where the item is stored

object

Metadata provided by the user

array<string>

List of user-defined tags

string

Time interval between item rotations

string

Target state for the previous version after rotation

string (date-time)

Timestamp of the last rotation

string (date-time)

Timestamp of the next rotation if auto-rotation is enabled

string (date-time)

Expiration timestamp

string (date-time)

Timestamp indicating when the item was created

string

Algorithm of the key

string

Purpose of the key:

  • signing - Asymmetric key used for creating and verifying cryptographic signatures
  • encryption - Asymmetric key used for encryption and decryption operations
  • jwt - Asymmetric key used for signing JSON Web Tokens (JWT), producing a verifiable JSON Web Signature (JWS)
  • pki - Asymmetric key used for Public Key Infrastructure (PKI) functions, such as certificate lifecycle management and identity verification
object

Full paths of the parent folders from which settings inherit their values

string
string
array<object>
integer

Item version

string (date-time)

Timestamp indicating when this version was created

string

State of the item version

string (date-time)

Timestamp indicating when this version will be destroyed

string

Public key (in PEM format)

boolean
(default: false)

true if the key is exportable

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"
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"
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"
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"
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/v1/list
curl -sSLX POST 'https://vault.aws.us.pangea.cloud/v1/list' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

List

POST
https://vault.aws.us.pangea.cloud/v1/list

Retrieve an array of Vault items matching a given filter, including secrets, keys, tokens, and folders, along with their common details.

fields

object

Filters to customize your search, for example:

{
  "folder": "/encryption",
  "tags": "personal",
  "name__contains": "my",
  "created_at__gt": "2020-03-11"
}
integer
(default: 50)

Maximum number of items in the response

  • maximum: 100
string

Direction for ordering the results

string

Property by which to order the results

string

Internal ID returned in the previous look up response. Used for pagination.

boolean
(default: false)

Include secret value for all items of type 'secret'

array<string>

Include additional information in the response

object

Pangea standard response schema

object
array<object>
string

ID of the item

string

Type of the Vault item

string

Name of the item

string

Folder where the item is stored

string (date-time)

Timestamp indicating when the item was created

array<string>

List of user-defined tags

object

Metadata provided by the user or system

string (date-time)

Timestamp of the last rotation

string (date-time)

Timestamp of the next rotation if auto-rotation is enabled

string (date-time)

Expiration timestamp

string

Time interval between item rotations

string

Target state for the previous version after rotation

string

State of the item

integer

Item version

string

Algorithm, applicable only if the item is a key

string

Purpose, applicable only if the item is a key

object

Full paths of the parent folders from which settings inherit their values

string
string
string
array<object>
integer

Item version

string (date-time)

Timestamp indicating when this version was created

string

State of the item version

string (date-time)

Timestamp indicating when this version will be destroyed

string

If 'include_secrets' was provided, and the list item type is 'secret', this value will be populated.

integer

Total number of items matching the given query

string

Internal ID returned in the previous look up response. Used for pagination.

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"
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"
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"
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"
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/v1/update
curl -sSLX POST 'https://vault.aws.us.pangea.cloud/v1/update' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Update

POST
https://vault.aws.us.pangea.cloud/v1/update

Update information associated with a key, secret, token, or folder.

required parameters

string (pangea-id)

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

string

Name of the item

string

Folder where the item is stored

object

Metadata provided by the user or system

array<string>

List of user-defined tags

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.

string

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

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.

string (date-time-or-never)

Expiration timestamp (in iso8601), never to disable expiration

string

New state of the item

object

Pangea standard response schema

object
string

ID of the item

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"
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"
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"
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"
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/v1/delete
curl -sSLX POST 'https://vault.aws.us.pangea.cloud/v1/delete' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Delete

POST
https://vault.aws.us.pangea.cloud/v1/delete

Delete a key, secret, token, or folder.

required parameters

string (pangea-id)

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

boolean

Applicable only to folders. Set to true to recursively delete all items inside the folder.

object

Pangea standard response schema

object
string

ID of the item

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"
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"
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"
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"
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/v1/export
curl -sSLX POST 'https://vault.aws.us.pangea.cloud/v1/export' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Export

POST
https://vault.aws.us.pangea.cloud/v1/export

Export a symmetric or asymmetric key marked as exportable when added to Vault.

required parameters

string (pangea-id)

ID of a key

integer

Version of the key. If not specified, the latest version is used by default.

  • minimum: 1
string

Public key (in PEM format) used to encrypt the exported key material

string

Public key algorithm

object

Pangea standard response schema

string

ID of the key

integer

Version of the key

string

Type of the Vault item

string

State of the item

string

Algorithm of the key

string

Public key (in PEM format)

string

Private key (in PEM format)

boolean

true if the exported key(s) are encrypted with encryption_key provided in the request. If so, the result is encoded in Base64; otherwise, the keys are in plain text PEM format.

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"
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"
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"
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"
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/v1/state/change
curl -sSLX POST 'https://vault.aws.us.pangea.cloud/v1/state/change' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Change state

POST
https://vault.aws.us.pangea.cloud/v1/state/change

Change the state of a version of a Vault key, secret, or token.

required parameters

string (pangea-id)

ID of a key, secret, or token

string

New state of the item version

integer

Version of the key, secret, or token. If not specified, the latest version is used by default.

  • minimum: 1
string (pangea-duration)

Period of time for the destruction of a compromised key, provided as a positive number followed by a time unit: secs, mins, hrs, days, weeks, months, or years. You can use an abbreviation like 1d. Applicable only if state is set to compromised.

object

Pangea standard response schema

object
string

ID of the item

integer

Item version

string

State of the item version

string (date-time)

Timestamp indicating when this version will be destroyed

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"
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"
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"
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"
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