Lockbox API, REST: Secret.create
Creates a secret in the specified folder.
HTTP request
POST https://lockbox.api.cloud.yandex.net/lockbox/v1/secrets
Body parameters
{
"folderId": "string",
"name": "string",
"description": "string",
"labels": "object",
"kmsKeyId": "string",
"versionDescription": "string",
"versionPayloadEntries": [
{
"key": "string",
// `versionPayloadEntries[]` includes only one of the fields `textValue`, `binaryValue`
"textValue": "string",
"binaryValue": "string",
// end of the list of possible fields`versionPayloadEntries[]`
}
],
"deletionProtection": true,
"passwordPayloadSpecification": {
"passwordKey": "string",
"length": "string",
"includeUppercase": true,
"includeLowercase": true,
"includeDigits": true,
"includePunctuation": true,
"includedPunctuation": "string",
"excludedPunctuation": "string"
}
}
Field | Description |
---|---|
folderId | string Required. ID of the folder to create a secret in. The maximum string length in characters is 50. |
name | string Name of the secret. The maximum string length in characters is 100. |
description | string Description of the secret. The maximum string length in characters is 1024. |
labels | object Custom labels for the secret as No more than 64 per resource. The maximum string length in characters for each key is 63. Each key must match the regular expression |
kmsKeyId | string Optional ID of the KMS key will be used to encrypt and decrypt the secret. The maximum string length in characters is 50. |
versionDescription | string Description of the first version. The maximum string length in characters is 256. |
versionPayloadEntries[] | object Payload entries added to the first version. The maximum number of elements is 32. |
versionPayloadEntries[]. key |
string Required. Non-confidential key of the entry. The maximum string length in characters is 256. Value must match the regular expression |
versionPayloadEntries[]. textValue |
string versionPayloadEntries[] includes only one of the fields textValue , binaryValue Use the field to set a text value. The maximum string length in characters is 65536. |
versionPayloadEntries[]. binaryValue |
string (byte) versionPayloadEntries[] includes only one of the fields textValue , binaryValue Use the field to set a binary value. The maximum string length in characters is 65536. |
deletionProtection | boolean (boolean) Flag that inhibits deletion of the secret. |
passwordPayloadSpecification | object |
passwordPayloadSpecification. passwordKey |
string Required. key of the entry to store generated password value The maximum string length in characters is 256. Value must match the regular expression |
passwordPayloadSpecification. length |
string (int64) password length; by default, a reasonable length will be decided The maximum value is 256. |
passwordPayloadSpecification. includeUppercase |
boolean (boolean) whether at least one A..Z character is included in the password, true by default |
passwordPayloadSpecification. includeLowercase |
boolean (boolean) whether at least one a..z character is included in the password, true by default |
passwordPayloadSpecification. includeDigits |
boolean (boolean) whether at least one 0..9 character is included in the password, true by default |
passwordPayloadSpecification. includePunctuation |
boolean (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 |
passwordPayloadSpecification. 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) The maximum string length in characters is 32. |
passwordPayloadSpecification. excludedPunctuation |
string a string of punctuation characters to exclude from the default (at most 31, it's not allowed to exclude all the 32) The maximum string length in characters is 31. |
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 , response 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. 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. |