secrets.sources.check

Check which references resolve — ok/error per reference, never a value

POST /secrets/api/sources/{id}/checkIAM secrets:UseSecretSourceChanges state

Request syntax

POST /secrets/api/sources/{id}/check
{
  "references": "array of string"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • referencesRequired

    array of string

    References to try through this source, 1 to 1000, each up to 512 characters; trimmed and de-duplicated. Each is answered ok or with its error; no value is returned.

    Constraints: 1-512 chars

Response

200 with one { reference, ok, error } per distinct reference. 502 when the source itself cannot be reached or refuses its credential.

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:UseSecretSource 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 check id --references '["example"]'

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