CHchecklyhq
Secret scans

Lists readable configuration values that look like inline credentials.

Changed on

Scans the account's checks (request headers, query parameters, basic auth, URLs, bodies, gRPC metadata, scripts, environment variables), check groups, snippets, alert channels, integrations, and account environment variables for readable values that look like credentials stored inline. Locked and secret-backed values are not inspected or reported. Each finding points at the exact field so the report can guide migration to secret environment variables. Detected values are never returned — only a redacted preview.

get/v1/secret-scans

Request

Headers

x-checkly-accountstring uuid

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Response

Successful

entityType'CHECK' | 'CHECK_GROUP' | 'SNIPPET' | 'ALERT_CHANNEL' | 'INTEGRATION' | 'ENVIRONMENT_VARIABLE' required

The kind of resource the flagged value lives on.

entityIdstring required

The id of the resource holding the flagged value. Numeric ids are serialized as strings.

entityNamestring nullable required

The display name (or key, for environment variables) of the resource.

checkTypestring nullable required

The check type when entityType is CHECK, null otherwise.

logicalIdstring nullable required

The monitoring-as-code logicalId of this resource within its project, null when not project-managed.

fieldPathstring required

Path of the flagged field on the public API resource, e.g. "request.headers[2].value".

fieldKeystring nullable required

The key of the flagged key-value entry (header name, query parameter name, variable key), if any.

valuePreviewstring nullable required

A redacted preview of the detected credential (a few leading/trailing characters). The full value is never returned; read the resource itself to retrieve it. Withheld (null) for INTEGRATION findings, whose credentials only admins can manage.

Example response

[
  {
    "fieldPath": "request.headers[2].value",
    "fieldKey": "Authorization",
    "valuePreview": "sk_l…7q"
  }
]

Changes

  • bc90d1bfa738Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • aba5d34c749bRevision changes
    • info

      endpoint added