Lockbox API, REST: Secret.addVersion
Adds new version based on a previous one.
HTTP request
POST https://lockbox.api.cloud.yandex.net/lockbox/v1/secrets/{secretId}:addVersion
Path parameters
| Parameter | Description |
|---|---|
| secretId | Required. ID of the secret. The maximum string length in characters is 50. |
Body parameters
{
"description": "string",
"payloadEntries": [
{
"key": "string",
// `payloadEntries[]` includes only one of the fields `textValue`, `binaryValue`
"textValue": "string",
"binaryValue": "string",
// end of the list of possible fields`payloadEntries[]`
}
],
"baseVersionId": "string"
}
| Field | Description |
|---|---|
| description | string Description of the version. The maximum string length in characters is 1024. |
| payloadEntries[] | object Describe how payload entries of the base version change in the added version. The maximum number of elements is 32. |
| payloadEntries[]. key |
string Required. Non-confidential key of the entry. The maximum string length in characters is 256. Value must match the regular expression |
| payloadEntries[]. textValue |
string payloadEntries[] includes only one of the fields textValue, binaryValueUse the field to set a text value. The maximum string length in characters is 65536. |
| payloadEntries[]. binaryValue |
string (byte) payloadEntries[] includes only one of the fields textValue, binaryValueUse the field to set a binary value. The maximum string length in characters is 65536. |
| baseVersionId | string Optional base version id. Defaults to the current version if not specified The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
| Field | Description |
|---|---|
| id | string ID of the operation. |
| description | string Description of the operation. 0-256 characters long. |
| 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). |
| createdBy | string ID of the user or service account who initiated the operation. |
| modifiedAt | string (date-time) The time when the Operation resource was last modified. 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). |
| done | boolean (boolean) If the value is |
| metadata | object Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
| error | object The error result of the operation in case of failure or cancellation. includes only one of the fields error, response |
| error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
| error. message |
string An error message. |
| error. details[] |
object A list of messages that carry the error details. |
| response | object includes only one of the fields error, responseThe normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |