Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Yandex Lockbox
  • Getting started
  • Quotas and limits
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • PayloadService
      • SecretService
      • OperationService
    • REST
      • Overview
      • Payload
        • Overview
        • get
      • Secret
        • Overview
        • activate
        • addVersion
        • cancelVersionDestruction
        • create
        • deactivate
        • delete
        • get
        • list
        • listAccessBindings
        • listOperations
        • listVersions
        • scheduleVersionDestruction
        • setAccessBindings
        • update
        • updateAccessBindings
  1. API reference
  2. REST
  3. Payload
  4. get

Method get

  • HTTP request
  • Path parameters
  • Query parameters
  • Response

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, binaryValue

Text value.

entries[].
binaryValue
string (byte)
entries[] includes only one of the fields textValue, binaryValue

Binary value.

In this article:
  • HTTP request
  • Path parameters
  • Query parameters
  • Response
Language
Careers
Privacy policy
Terms of use
© 2021 Yandex.Cloud LLC