[Yandex Cloud documentation](../../../index.md) > [Yandex Lockbox](../../index.md) > API reference > [REST](../index.md) > [Secret](index.md) > Update # Lockbox API, REST: Secret.Update Updates the specified secret. ## HTTP request ``` PATCH https://lockbox.api.cloud.yandex.net/lockbox/v1/secrets/{secretId} ``` ## Path parameters #| ||Field | Description || || secretId | **string** Required field. ID of the secret to update. The maximum string length in characters is 50. || |# ## Body parameters {#yandex.cloud.lockbox.v1.UpdateSecretRequest} ```json { // Includes only one of the fields `passwordPayloadSpecification` "passwordPayloadSpecification": { "passwordKey": "string", "length": "string", "includeUppercase": "boolean", "includeLowercase": "boolean", "includeDigits": "boolean", "includePunctuation": "boolean", "includedPunctuation": "string", "excludedPunctuation": "string" }, // end of the list of possible fields "updateMask": "string", "name": "string", "description": "string", "labels": "object", "deletionProtection": "boolean" } ``` #| ||Field | Description || || passwordPayloadSpecification | **[PasswordPayloadSpecification](#yandex.cloud.lockbox.v1.PasswordPayloadSpecification)** Includes only one of the fields `passwordPayloadSpecification`. || || updateMask | **string** (field-mask) Required field. A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `` updateMask `` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `` updateMask `` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default. || || name | **string** New name of the secret. The maximum string length in characters is 100. || || description | **string** New description of the secret. The maximum string length in characters is 1024. || || labels | **object** (map<**string**, **string**>) Custom labels for the secret as `key:value` pairs. Maximum 64 per key. The maximum string length in characters for each value is 63. The maximum string length in characters for each key is 63. Each key must match the regular expression ` [a-z][-_0-9a-z]* `. Each value must match the regular expression ` [-_0-9a-z]* `. No more than 64 per resource. || || deletionProtection | **boolean** Flag that inhibits deletion of the secret. || |# ## PasswordPayloadSpecification {#yandex.cloud.lockbox.v1.PasswordPayloadSpecification} #| ||Field | Description || || passwordKey | **string** Required field. key of the entry to store generated password value Value must match the regular expression ` [-_./\\@0-9a-zA-Z]+ `. || || length | **string** (int64) password length; by default, a reasonable length will be decided The maximum value is 256. || || includeUppercase | **boolean** whether at least one A..Z character is included in the password, true by default || || includeLowercase | **boolean** whether at least one a..z character is included in the password, true by default || || includeDigits | **boolean** whether at least one 0..9 character is included in the password, true by default || || includePunctuation | **boolean** whether at least one punctuation character is included in the password, true by default punctuation characters by default (there are 32): !"#$%&'()*+,-./:;<=>?@[\]^_`{\|}~ to customize the punctuation characters, see included_punctuation and excluded_punctuation below || || includedPunctuation | **string** If include_punctuation is true, one of these two fields (not both) may be used optionally to customize the punctuation: a string of specific punctuation characters to use (at most, all the 32) || || excludedPunctuation | **string** a string of punctuation characters to exclude from the default (at most 31, it's not allowed to exclude all the 32) || |# ## Response {#yandex.cloud.operation.Operation} **HTTP Code: 200 - OK** ```json { "id": "string", "description": "string", "createdAt": "string", "createdBy": "string", "modifiedAt": "string", "done": "boolean", "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](../../../api-design-guide/concepts/operation.md). #| ||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](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the [Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). 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](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the [Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || done | **boolean** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. || || 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 | **[Status](#google.rpc.Status)** The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set. || || response | **object** The 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#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. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set. || |# ## Status {#google.rpc.Status} The error result of the operation in case of failure or cancellation. #| ||Field | Description || || code | **integer** (int32) Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || || message | **string** An error message. || || details[] | **object** A list of messages that carry the error details. || |#