Lockbox API, gRPC: PayloadService.Get
Written by
Updated at October 17, 2024
Returns the payload of the specified secret.
To get the list of all available secrets, make a SecretService.List request.
gRPC request
rpc Get (GetPayloadRequest) returns (Payload)
GetPayloadRequest
{
"secretId": "string",
"versionId": "string"
}
|
Field |
Description |
|
secretId |
string Required field. ID of the secret. |
|
versionId |
string Optional ID of the version. |
Payload
{
"versionId": "string",
"entries": [
{
"key": "string",
// Includes only one of the fields `textValue`, `binaryValue`
"textValue": "string",
"binaryValue": "bytes"
// end of the list of possible fields
}
]
}
A payload.
|
Field |
Description |
|
versionId |
string ID of the version that the payload belongs to. |
|
entries[] |
Payload entries. |
Entry
|
Field |
Description |
|
key |
string Non-confidential key of the entry. |
|
textValue |
string Text value. Includes only one of the fields Confidential value of the entry. |
|
binaryValue |
bytes Binary value. Includes only one of the fields Confidential value of the entry. |