Create a secret

/v1.33

POST

/secrets/create

Secret

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1.33/secrets/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Data": "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==",
    "Driver": {
        "Name": "secret-bucket",
        "Options": {
            "OptionA": "value for driver option A",
            "OptionB": "value for driver option B"
        }
    },
    "Labels": {
        "com.example.some-label": "some-value",
        "com.example.some-other-label": "some-other-value",
        "foo": "bar"
    },
    "Name": "app-key.crt"
}'

Response Example

201 - Example 1

{
    "ID": "ktnbjxoalbkvbvedmg1urrz8h"
}

Request

Body Params application/json

Data

string

optional

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:

Driver

object

Driver

optional

Driver represents a driver (network, logging, secrets).

Name

string

required

Name of the driver.

Example:

some-driver

Options

object

optional

Key/value map of driver-specific options.

Example:

{"OptionA":"value for driver-specific option A","OptionB":"value for driver-specific option B"}

Labels

object

optional

User-defined key/value metadata.

Example:

{"com.example.some-label":"some-value","com.example.some-other-label":"some-other-value"}

Name

string

optional

User-defined name of the secret.

Examples

Responses

🟢201no error

application/json

Body

string

optional

The ID of the created secret.

🟠409name conflicts with an existing object

🔴500server error

🔴503node is not part of a swarm

Modified at 2022-09-10 17:56:07

List secrets

Delete a secret