Lockbox API, REST: Secret.ListVersions
Retrieves the list of versions of the specified secret.
HTTP request
GET https://lockbox.api.cloud.yandex.net/lockbox/v1/secrets/{secretId}/versions
Path parameters
Field |
Description |
secretId |
string Required field. ID of the secret to list versions for. |
Query parameters
Field |
Description |
pageSize |
string (int64) The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, set |
Response
HTTP Code: 200 - OK
{
"versions": [
{
"id": "string",
"secretId": "string",
"createdAt": "string",
"destroyAt": "string",
"description": "string",
"status": "string",
"payloadEntryKeys": [
"string"
],
// Includes only one of the fields `passwordPayloadSpecification`
"passwordPayloadSpecification": {
"passwordKey": "string",
"length": "string",
"includeUppercase": "boolean",
"includeLowercase": "boolean",
"includeDigits": "boolean",
"includePunctuation": "boolean",
"includedPunctuation": "string",
"excludedPunctuation": "string"
}
// end of the list of possible fields
}
],
"nextPageToken": "string"
}
Field |
Description |
versions[] |
List of versions for the specified secret. |
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number |
Version
Field |
Description |
id |
string ID of the version. |
secretId |
string ID of the secret that the version belongs to. |
createdAt |
string (date-time) Time when the version was created. String in RFC3339 To work with values in this field, use the APIs described in the |
destroyAt |
string (date-time) Time when the version is going to be destroyed. Empty unless the status String in RFC3339 To work with values in this field, use the APIs described in the |
description |
string Description of the version. |
status |
enum (Status) Status of the secret.
|
payloadEntryKeys[] |
string Keys of the entries contained in the version payload. |
passwordPayloadSpecification |
Includes only one of the fields |
PasswordPayloadSpecification
Field |
Description |
passwordKey |
string Required field. key of the entry to store generated password value |
length |
string (int64) password length; by default, a reasonable length will be decided |
includeUppercase |
boolean whether at least one A..Z character is included in the password, true by default |
includeLowercase |
boolean whether at least one a..z character is included in the password, true by default |
includeDigits |
boolean whether at least one 0..9 character is included in the password, true by default |
includePunctuation |
boolean whether at least one punctuation character is included in the password, true by default |
includedPunctuation |
string If include_punctuation is true, one of these two fields (not both) may be used optionally to customize the punctuation: |
excludedPunctuation |
string a string of punctuation characters to exclude from the default (at most 31, it's not allowed to exclude all the 32) |