secrets.sources.update

Rename the source, replace the credential or change the refresh interval

PATCH /secrets/api/sources/{id}IAM secrets:UpdateSecretSourceChanges stateDestructive

Request syntax

PATCH /secrets/api/sources/{id}
{
  "name": "string",
  "description": "string",
  "credential": "string",
  "config": "map of string",
  "refreshIntervalMinutes": "number"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • nameOptional

    string

    New name, 2 to 63 lower-case letters, digits and hyphens; its credential secret is renamed to SOURCE_<NAME>_TOKEN with it. A taken name (or credential secret name) is 409. Synced secrets follow the source by id.

    Constraints: 2-63 chars, /^[a-z0-9][a-z0-9-]*$/

  • descriptionOptional

    string

    Free-text description, up to 256 characters. Null clears it; omitted: unchanged.

    Constraints: max 256 chars

    May be null.

  • credentialOptional

    string

    A replacement credential, 8 to 8192 characters. Verified first (rejected: 422), then written as a new version of the credential secret. Omitted: unchanged.

    Constraints: 8-8192 chars

  • configOptional

    map of string

    Replaces the provider settings whole (the same keys as on create). Verified with the new or the stored credential first: 400 for invalid settings, 422 when the provider refuses them. Omitted: unchanged.

    Constraints: key=value

  • refreshIntervalMinutesOptional

    number

    Minutes between scheduled syncs, 5 to 1440. Omitted: unchanged.

    Constraints: integer, 5-1440

Response

200 with { id }. 422 when the provider rejects a new credential or settings; 409 for a taken name.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow secrets:UpdateSecretSource on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud secrets sources update id

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_secrets_sources_update.