Skip to main content

Vault V2 General API Reference

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

Response

Get

POST
https://vault.aws.us.pangea.cloud/v2/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 the version <num> steps back starting from the current one (e.g., -2 from version 5 returns version 4).
  • -<num>: - Retrieve last <num> versions of the item.
  • <no-value> - Return the current version.
object

Pangea standard response schema

string

ID of the key

string

Type of the Vault item

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
boolean
(default: false)

true if the key is exportable

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 (date-time)

Timestamp of the last rotation

string

Public key (in PEM format)

object

Metadata provided by the user

integer

Total number of versions of the item

boolean

true if the item is enabled

string

Name of the item

string

Folder where the item is stored

array<string>

List of user-defined tags

string (date-time)

Timestamp of the last rotation

string (date-time)

Timestamp of the next rotation if auto-rotation is enabled

string (date-time)

Timestamp indicating when the item will be disabled

string (date-time)

Timestamp indicating when the item was created

string

Time interval between item rotations

string

Target state for the previous version after rotation

object

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

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

Response

Get bulk

POST
https://vault.aws.us.pangea.cloud/v2/get_bulk

Retrieve details for multiple Vault items, including keys, secrets, tokens, or folders, that match a given filter specification.

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.

object

Pangea standard response schema

object
string

ID of the key

string

Type of the Vault item

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
boolean
(default: false)

true if the key is exportable

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 (date-time)

Timestamp of the last rotation

string

Public key (in PEM format)

object

Metadata provided by the user

integer

Total number of versions of the item

boolean

true if the item is enabled

string

Name of the item

string

Folder where the item is stored

array<string>

List of user-defined tags

string (date-time)

Timestamp of the last rotation

string (date-time)

Timestamp of the next rotation if auto-rotation is enabled

string (date-time)

Timestamp indicating when the item will be disabled

string (date-time)

Timestamp indicating when the item was created

string

Time interval between item rotations

string

Target state for the previous version after rotation

object

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

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

Response

List

POST
https://vault.aws.us.pangea.cloud/v2/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.

object

Pangea standard response schema

object
array<object>
string

ID of the item

string

Type of the Vault item

boolean
(default: false)

true if the key is exportable, applicable only if the item is a key

string

Algorithm, applicable only if the item is a key

string

Purpose, applicable only if the item is a key

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 (date-time)

Timestamp of the last rotation

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 (date-time)

Timestamp of the last rotation

object

Metadata provided by the user or system

integer

Total number of versions of the item

boolean

true if the item is enabled

string

Name of the item

string

Folder where the item is stored

array<string>

List of user-defined tags

string (date-time)

Timestamp of the last rotation

string (date-time)

Timestamp of the next rotation if auto-rotation is enabled

string (date-time)

Timestamp indicating when the item will be disabled

string (date-time)

Timestamp indicating when the item was created

string

Time interval between item rotations

string

Target state for the previous version after rotation

string

Grace period for the previous version

object

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

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

Response

Update

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

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

fields

string (pangea-id)

ID of a secret

string

Name to be assigned to the secret

string

Folder where the item is stored

object

Metadata provided by the user

array<string>

List of user-defined tags

boolean

Set to true to enable the item or false to disable it

string (date-time)

Timestamp indicating when the item will be disabled

object

Pangea standard response schema

string

ID of the key

string

Type of the Vault item

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
boolean
(default: false)

true if the key is exportable

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 (date-time)

Timestamp of the last rotation

string

Public key (in PEM format)

object

Metadata provided by the user

integer

Total number of versions of the item

boolean

true if the item is enabled

string

Name of the item

string

Folder where the item is stored

array<string>

List of user-defined tags

string (date-time)

Timestamp of the last rotation

string (date-time)

Timestamp of the next rotation if auto-rotation is enabled

string (date-time)

Timestamp indicating when the item will be disabled

string (date-time)

Timestamp indicating when the item was created

string

Time interval between item rotations

string

Target state for the previous version after rotation

object

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

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

Response

Delete

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

Response

Export

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

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

When no asymmetric_algorithm option is selected, the exported symmetric key material is a Base64-encoded byte array, and the asymmetric key pair is exported in PEM format.

When an asymmetric_algorithm option is selected, the asymmetric_public_key parameter must be populated with an RSA-4096 key.

If asymmetric_algorithm is set to RSA-OAEP-4096-SHA512, only key material up to 382 bytes can be encrypted using the provided asymmetric_public_key value. The exported symmetric and asymmetric private key material is encrypted and Base64-encoded. Public keys are exported in PEM format.

Set asymmetric_algorithm to RSA-KEM-NO-PADDING-4096 to securely export key material of any length using the Key Encapsulation Method (KEM), as described in RFC 5990.

Learn more about exporting key material from Vault in the Export a Key documentation.

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

Encryption option for exporting key material. Use RSA-OAEP-4096-SHA512 for traditional public key encryption of key material up to 382 bytes. Use RSA-NO-PADDING-4096-KEM for KEM encryption, which supports key material of any length. See Encrypting and exporting a key using KEM for additional details.

string

Public key for use with the RSA-OAEP-4096-SHA512 algorithm in PEM format. When RSA-OAEP-4096-SHA512 is selected as asymmetric_algorithm, the public key is used to encrypt exported key material up to 382 bytes in length. When RSA-NO-PADDING-4096-KEM is selected, the public key encrypts a salt used with the kem_password parameter to derive a symmetric key, which is then used to encrypt the exported key material. The encrypted salt is returned in result.encrypted_salt.

string

Password used with a salt to derive the symmetric key for encrypting the exported key material in Key Encapsulation Mechanism (KEM). Required if asymmetric_algorithm is set to RSA-NO-PADDING-4096-KEM.

object

Pangea standard response schema

string

ID of the key

integer

Version of the key

boolean

true if the item is enabled

string

Encryption option for exporting key material. Use RSA-OAEP-4096-SHA512 for traditional public key encryption of key material up to 382 bytes. Use RSA-NO-PADDING-4096-KEM for KEM encryption, which supports key material of any length. See Encrypting and exporting a key using KEM for additional details.

string

Algorithm of the symmetric key used to encrypt the exported key material when encryption_type is kem

string

Algorithm of the key

string

Encryption format of the exported key(s):

  • none - Plain text, unencrypted
  • asymmetric - Encrypted using only the public key provided in the asymmetric_public_key parameter
  • kem - Encrypted using KEM protocol
string

Key Derivation Function (KDF) used to derive the symmetric key for encrypting the exported key material when encryption_type is kem

string

Hash algorithm used to derive the symmetric key for encrypting the exported key material when encryption_type is kem

integer

Iteration count used to derive the symmetric key for encrypting the exported key material when encryption_type is kem

string

Salt used to derive the symmetric key for encrypting the exported key material when encryption_type is kem, encrypted with the public key provided in the asymmetric_public_key parameter (Base64-encoded)

string

Public key (in PEM format)

string

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

Response

Change state

POST
https://vault.aws.us.pangea.cloud/v2/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

string

ID of the key

string

Type of the Vault item

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
boolean
(default: false)

true if the key is exportable

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 (date-time)

Timestamp of the last rotation

string

Public key (in PEM format)

object

Metadata provided by the user

integer

Total number of versions of the item

boolean

true if the item is enabled

string

Name of the item

string

Folder where the item is stored

array<string>

List of user-defined tags

string (date-time)

Timestamp of the last rotation

string (date-time)

Timestamp of the next rotation if auto-rotation is enabled

string (date-time)

Timestamp indicating when the item will be disabled

string (date-time)

Timestamp indicating when the item was created

string

Time interval between item rotations

string

Target state for the previous version after rotation

object

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

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