Secret

Create a secret

post/secrets/create

Request

  • Base URL
    /v1.49 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1.49/secrets/create
  • Auth
    none declared

Request body

Namestring

User-defined name of the secret.

Labelsobject

User-defined key/value metadata.

Datastring

Data is the data to store as a secret, formatted as a Base64-url-safe-encoded (RFC 4648) string. It must be empty if the Driver field is set, in which case the data is loaded from an external secret store. The maximum allowed size is 500KB, as defined in MaxSecretSize.

This field is only used to create a secret, and is not returned by other endpoints.

Example request

{
  "Name": "app-key.crt",
  "Labels": {
    "foo": "bar"
  },
  "Data": "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==",
  "Driver": {
    "Name": "secret-bucket",
    "Options": {
      "OptionA": "value for driver option A",
      "OptionB": "value for driver option B"
    }
  }
}

Response

no error

Idstring required

The id of the newly created object.

Changes

No recorded changes to this operation across all 4 revisions of this API.