Lockbox API, REST: Payload.get
Статья создана
Обновлена 14 июня 2023 г.
Returns the payload of the specified secret.
To get the list of all available secrets, make a list request.
HTTP request
GET https://payload.lockbox.api.cloud.yandex.net/lockbox/v1/secrets/{secretId}/payload
Path parameters
| Parameter | Description |
|---|---|
| secretId | Required. ID of the secret. The maximum string length in characters is 50. |
Query parameters
| Parameter | Description |
|---|---|
| versionId | Optional ID of the version. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"versionId": "string",
"entries": [
{
"key": "string",
// `entries[]` includes only one of the fields `textValue`, `binaryValue`
"textValue": "string",
"binaryValue": "string",
// end of the list of possible fields`entries[]`
}
]
}
A payload.
| Field | Description |
|---|---|
| versionId | string ID of the version that the payload belongs to. |
| entries[] | object Payload entries. |
| entries[]. key |
string Non-confidential key of the entry. |
| entries[]. textValue |
string entries[] includes only one of the fields textValue, binaryValueText value. |
| entries[]. binaryValue |
string (byte) entries[] includes only one of the fields textValue, binaryValueBinary value. |