secrets.environments.matrix

Every secret name × Default and each environment: what each environment resolves it to

GET /secrets/api/environments/matrixIAM secrets:ListSecretsRead

`resolves[envId].resolution` is own, default (no own secret: the Default value) or missing; `promotableFrom` names an earlier environment that has it. `compare=1` adds a `valueClass` letter per cell (same letter, same value), audited per secret. Values are never returned.

Depending on the resource, the call checks secrets:CompareSecretValues instead; hold all of them to be sure it is allowed.

Request syntax

GET /secrets/api/environments/matrix

Query parameters

  • compareOptional

    enum

    1: add a `valueClass` letter to each cell (the same letter, the same value), compared on the server; needs secrets:CompareSecretValues on each secret, each compare audited, refused ones counted in `notCompared`. Omitted or 0: no comparison.

    One of: 0, 1

  • groupOptional

    string

    Only names filed in this group or a group below it, e.g. dialog or dialog/auth; up to 122 characters. Omitted: every group, Ungrouped included.

    Constraints: max 122 chars

Response

200 with { environments, rows, compared, notCompared }: the environments (as list describes them, without counts), one row per name { name, group, cells, resolves }, whether values were compared, and how many secrets could not be. Each cell: secretId, version, synced, reference, syncError, updatedAt, valueClass.

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:ListSecrets 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 environments matrix

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