Method create

Статья создана

HTTP request
Body parameters
Response

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
}

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 `key:value` pairs. Maximum 64 per key. For example, `"project": "mvp"` or `"source": "dictionary"`. No more than 64 per resource. The maximum string length in characters for each key is 63. Each key must match the regular expression `[a-z][-_0-9a-z]`. The maximum string length in characters for each value is 63. Each value must match the regular expression `[-_0-9a-z]`.
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 `[-_./\\@0-9a-zA-Z]+`.
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.

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.
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.
done	boolean (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	object The error result of the operation in case of failure or cancellation. includes only one of the fields `error`, `response` The error result of the operation in case of failure or cancellation.
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.

Method create

HTTP request

Body parameters

Response

Была ли статья полезна?