Secret

Create a secret

post/secrets/create

Request

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

Request body

Namestring

User-defined name of the secret.

Labelsobject

User-defined key/value metadata.

Datastring

Base64-url-safe-encoded (RFC 4648) data to store as secret.

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 70 revisions of this API.