Lockbox API, REST: Secret.list
Retrieves the list of secrets in the specified folder.
HTTP request
GET https://lockbox.api.cloud.yandex.net/lockbox/v1/secrets
Query parameters
Parameter | Description |
---|---|
folderId | Required. ID of the folder to list secrets in. The maximum string length in characters is 50. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"secrets": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"kmsKeyId": "string",
"status": "string",
"currentVersion": {
"id": "string",
"secretId": "string",
"createdAt": "string",
"destroyAt": "string",
"description": "string",
"status": "string",
"payloadEntryKeys": [
"string"
],
"passwordPayloadSpecification": {
"passwordKey": "string",
"length": "string",
"includeUppercase": true,
"includeLowercase": true,
"includeDigits": true,
"includePunctuation": true,
"includedPunctuation": "string",
"excludedPunctuation": "string"
}
},
"deletionProtection": true,
"passwordPayloadSpecification": {
"passwordKey": "string",
"length": "string",
"includeUppercase": true,
"includeLowercase": true,
"includeDigits": true,
"includePunctuation": true,
"includedPunctuation": "string",
"excludedPunctuation": "string"
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
secrets[] | object List of secrets in the specified folder. |
secrets[]. id |
string ID of the secret. |
secrets[]. folderId |
string ID of the folder that the secret belongs to. |
secrets[]. createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
secrets[]. name |
string Name of the secret. |
secrets[]. description |
string Description of the secret. |
secrets[]. labels |
object Custom labels for the secret as |
secrets[]. kmsKeyId |
string Optional ID of the KMS key will be used to encrypt and decrypt the secret. |
secrets[]. status |
string Status of the secret.
|
secrets[]. currentVersion |
object Current (i.e. the latest ) version of the secret. |
secrets[]. currentVersion. id |
string ID of the version. |
secrets[]. currentVersion. secretId |
string ID of the secret that the version belongs to. |
secrets[]. currentVersion. createdAt |
string (date-time) Time when the version was created. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
secrets[]. currentVersion. destroyAt |
string (date-time) Time when the version is going to be destroyed. Empty unless the status is String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
secrets[]. currentVersion. description |
string Description of the version. |
secrets[]. currentVersion. status |
string Status of the secret.
|
secrets[]. currentVersion. payloadEntryKeys[] |
string Keys of the entries contained in the version payload. |
secrets[]. currentVersion. passwordPayloadSpecification |
object |
secrets[]. currentVersion. passwordPayloadSpecification. passwordKey |
string Required. key of the entry to store generated password value The maximum string length in characters is 256. Value must match the regular expression |
secrets[]. currentVersion. passwordPayloadSpecification. length |
string (int64) password length; by default, a reasonable length will be decided The maximum value is 256. |
secrets[]. currentVersion. passwordPayloadSpecification. includeUppercase |
boolean (boolean) whether at least one A..Z character is included in the password, true by default |
secrets[]. currentVersion. passwordPayloadSpecification. includeLowercase |
boolean (boolean) whether at least one a..z character is included in the password, true by default |
secrets[]. currentVersion. passwordPayloadSpecification. includeDigits |
boolean (boolean) whether at least one 0..9 character is included in the password, true by default |
secrets[]. currentVersion. passwordPayloadSpecification. includePunctuation |
boolean (boolean) whether at least one punctuation character is included in the password, true by default punctuation characters by default (there are 32): !"#$%&'()*+,-./:;<=>?@[]^_`{|}~ to customize the punctuation characters, see included_punctuation and excluded_punctuation below |
secrets[]. currentVersion. passwordPayloadSpecification. includedPunctuation |
string If include_punctuation is true, one of these two fields (not both) may be used optionally to customize the punctuation: a string of specific punctuation characters to use (at most, all the 32) The maximum string length in characters is 32. |
secrets[]. currentVersion. passwordPayloadSpecification. excludedPunctuation |
string a string of punctuation characters to exclude from the default (at most 31, it's not allowed to exclude all the 32) The maximum string length in characters is 31. |
secrets[]. deletionProtection |
boolean (boolean) Flag that inhibits deletion of the secret. |
secrets[]. passwordPayloadSpecification |
object |
secrets[]. passwordPayloadSpecification. passwordKey |
string Required. key of the entry to store generated password value The maximum string length in characters is 256. Value must match the regular expression |
secrets[]. passwordPayloadSpecification. length |
string (int64) password length; by default, a reasonable length will be decided The maximum value is 256. |
secrets[]. passwordPayloadSpecification. includeUppercase |
boolean (boolean) whether at least one A..Z character is included in the password, true by default |
secrets[]. passwordPayloadSpecification. includeLowercase |
boolean (boolean) whether at least one a..z character is included in the password, true by default |
secrets[]. passwordPayloadSpecification. includeDigits |
boolean (boolean) whether at least one 0..9 character is included in the password, true by default |
secrets[]. passwordPayloadSpecification. includePunctuation |
boolean (boolean) whether at least one punctuation character is included in the password, true by default punctuation characters by default (there are 32): !"#$%&'()*+,-./:;<=>?@[]^_`{|}~ to customize the punctuation characters, see included_punctuation and excluded_punctuation below |
secrets[]. passwordPayloadSpecification. includedPunctuation |
string If include_punctuation is true, one of these two fields (not both) may be used optionally to customize the punctuation: a string of specific punctuation characters to use (at most, all the 32) The maximum string length in characters is 32. |
secrets[]. passwordPayloadSpecification. excludedPunctuation |
string a string of punctuation characters to exclude from the default (at most 31, it's not allowed to exclude all the 32) The maximum string length in characters is 31. |
nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is greater than the specified pageSize, use the |