For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.v2.security.secrets.bySecret(secret).put(body: WithSecretPutRequestBody, requestConfiguration?: RequestConfiguration<object>): Promise<undefined | Create_secret_response>

Description

To update a secret, send a PUT request to /v2/security/secrets/{secret}.

version is the secret’s current version. If it does not match, the request returns a 409 response and the secret is not changed.

Parameters

Path Parameters

secret string required

Example: my-database-password

The name of the secret.

Request Body

region string required

Example: nyc3

The region where the secret is stored.

version integer required

Example: 1

The current version of the secret to update.

values object required

Example: {"password": "n3w-s3cr3t"}

Updated key-value pairs for the secret.

Response Example

{
  "name": "my-database-password",
  "region": "nyc3",
  "version": 1
}

More Information

See /v2/security/secrets/{secret} in the API reference for additional detail on responses, headers, parameters, and more.