Qodex.ai

Search detected secrets

POST {{baseUrl}}/detected-secrets-queries

Returns all secrets detected by Qodex's [Secret Scanner] grouped by workspace. If you pass an empty request body, this endpoint returns all results.

You can include the following properties in the request body:

  • secretTypes — An array that contains a list of secrets types to query. For a list of valid IDs, use the GET /secret-types endpoint.

  • resolved — A boolean value that, if true, return secrets with a resolved status.

  • statuses — An array that contains a list of the secret resolution status type:

    • FALSE_POSITIVE — The discovered secret is not an actual secret.
    • REVOKED — The secret is valid, but the user rotated their key to resolve the issue.
    • ACCEPTED_RISK — The Secret Scanner found the secret, but user accepts the risk of publishing it.

  • workspaceIds — An array that contains a list of workspaces IDs to query.

  • workspaceVisibilities — An array that contains a list of workspace [visibility settings] to query. This currently supports the team and public settings.

Request Params

KeyDatatypeRequiredDescription
limitstringThe maximum number of rows to return in the response.
cursorstringThe pointer to the first record of the set of paginated results.
includestringThe additional fields to be included as a part of this API request.

RESPONSES

status: OK

{"data":[{"obfuscatedSecret":"keyTF2WAH******","occurrences":3,"resolution":"FALSE_POSITIVE","secretHash":"07afd1f787f3555d441b04870dbe1025db8309fbeb31f25b3a20f2f1241478b3","secretId":"OTI3OTYx","secretType":"Airtable API Key","detectedAt":"2023-05-19T02:45:31.000Z","workspaceId":"e361eeb4-00dd-4225-9774-6146a2555999","workspaceVisibility":"team"},{"obfuscatedSecret":"xoxp-25519******","occurrences":1,"resolution":"ACCEPTED_RISK","secretHash":"08074c0954fd29d1ee82ab5af9b4ad16f56b0907eca72446e98dc97e10da80a3","secretId":"NDcyMjA=","secretType":"Slack Access Token","detectedAt":"2023-03-23T19:38:49.000Z","workspaceId":"e361eeb4-00dd-4225-9774-6146a2555999","workspaceVisibility":"team"}],"meta":{"limit":2,"nextCursor":null,"total":20}}