Update a Secret

/v1.33

POST

/secrets/{id}/update

Secret

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1.33/secrets//update?version=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Data": "",
    "Driver": {
        "Name": "some-driver",
        "Options": {
            "OptionA": "value for driver-specific option A",
            "OptionB": "value for driver-specific option B"
        }
    },
    "Labels": {
        "com.example.some-label": "some-value",
        "com.example.some-other-label": "some-other-value"
    },
    "Name": "string"
}'

Response Example

200 - Example 1

{}

Request

Path Params

string

required

The ID or name of the secret

Query Params

version

integer

required

The version number of the secret object being updated. This is required to avoid conflicting writes.

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"}

Additional properties

string

optional

Name

string

optional

User-defined name of the secret.

Examples

Responses

🟢200no error

application/json

Body

object {0}

🟠400bad parameter

🟠404no such secret

🔴500server error

🔴503node is not part of a swarm

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

Inspect a secret

List services