Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Lockbox
  • Getting started
  • Quotas and limits
  • Access management
  • Pricing policy
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • GetEx
  • Monitoring metrics
  • Audit Trails events
  • Release notes
  • FAQ

In this article:

  • gRPC request
  • GetPayloadRequest
  • Payload
  • Entry
  1. API reference
  2. gRPC
  3. Payload
  4. Get

Lockbox API, gRPC: PayloadService.Get

Written by
Yandex Cloud
Updated at November 26, 2024
  • gRPC request
  • GetPayloadRequest
  • Payload
  • Entry

Returns the payload of the specified secret.

To get the list of all available secrets, make a SecretService.List request.

gRPC requestgRPC request

rpc Get (GetPayloadRequest) returns (Payload)

GetPayloadRequestGetPayloadRequest

{
  "secret_id": "string",
  "version_id": "string"
}

Field

Description

secret_id

string

Required field. ID of the secret.

version_id

string

Optional ID of the version.

PayloadPayload

{
  "version_id": "string",
  "entries": [
    {
      "key": "string",
      // Includes only one of the fields `text_value`, `binary_value`
      "text_value": "string",
      "binary_value": "bytes"
      // end of the list of possible fields
    }
  ]
}

A payload.

Field

Description

version_id

string

ID of the version that the payload belongs to.

entries[]

Entry

Payload entries.

EntryEntry

Field

Description

key

string

Non-confidential key of the entry.

text_value

string

Text value.

Includes only one of the fields text_value, binary_value.

Confidential value of the entry.

binary_value

bytes

Binary value.

Includes only one of the fields text_value, binary_value.

Confidential value of the entry.

Was the article helpful?

Previous
Overview
Next
GetEx
© 2025 Direct Cursus Technology L.L.C.