Update a Secret Run in API Explorer

POST /secrets/{id}/update

Path parameters

  • id string Required

    The ID or name of the secret

Query parameters

  • version integer(int64) Required

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

application/json

Body

The spec of the secret to update. Currently, only the Labels field can be updated. All other fields must remain unchanged from the SecretInspect endpoint response values.

  • Name string

    User-defined name of the secret.

  • Labels object

    User-defined key/value metadata.

    Hide Labels attribute Show Labels attribute object
    • * string Additional properties
  • Data string

    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.

  • Driver object

    Name of the secrets driver used to fetch the secret's value from an external secret store.

    Hide Driver attributes Show Driver attributes object
    • Name string Required

      Name of the driver.

    • Options object

      Key/value map of driver-specific options.

      Hide Options attribute Show Options attribute object
      • * string Additional properties
  • Templating object

    Name of the secrets driver used to fetch the secret's value from an external secret store.

    Hide Templating attributes Show Templating attributes object
    • Name string Required

      Name of the driver.

    • Options object

      Key/value map of driver-specific options.

      Hide Options attribute Show Options attribute object
      • * string Additional properties

Responses

  • 200

    no error

  • 400 application/json

    bad parameter

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
  • 404 application/json

    no such secret

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
  • 500 application/json

    server error

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
  • 503 application/json

    node is not part of a swarm

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
POST /secrets/{id}/update 
curl \
 --request POST 'http://api.example.com/v1.44/secrets/{id}/update?version=42' \
 --header "Content-Type: application/json" \
 --data '{"Name":"string","Labels":{"com.example.some-label":"some-value","com.example.some-other-label":"some-other-value"},"Data":"string","Driver":{"Name":"some-driver","Options":{"OptionA":"value for driver-specific option A","OptionB":"value for driver-specific option B"}},"Templating":{"Name":"some-driver","Options":{"OptionA":"value for driver-specific option A","OptionB":"value for driver-specific option B"}}}'
Request examples 
{
  "Name": "string",
  "Labels": {
    "com.example.some-label": "some-value",
    "com.example.some-other-label": "some-other-value"
  },
  "Data": "string",
  "Driver": {
    "Name": "some-driver",
    "Options": {
      "OptionA": "value for driver-specific option A",
      "OptionB": "value for driver-specific option B"
    }
  },
  "Templating": {
    "Name": "some-driver",
    "Options": {
      "OptionA": "value for driver-specific option A",
      "OptionB": "value for driver-specific option B"
    }
  }
}
Response examples (400) 
{
  "message": "Something went wrong."
}
Response examples (400) 
{
  "message": "Something went wrong."
}
Response examples (404) 
{
  "message": "Something went wrong."
}
Response examples (404) 
{
  "message": "Something went wrong."
}
Response examples (500) 
{
  "message": "Something went wrong."
}
Response examples (500) 
{
  "message": "Something went wrong."
}
Response examples (503) 
{
  "message": "Something went wrong."
}
Response examples (503) 
{
  "message": "Something went wrong."
}