Search detected secrets

POST

/detected-secrets-queries

POST

/detected-secrets-queries

curl -X POST https://api.postman.com/detected-secrets-queries \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "resolved": true,
  "secretTypes": [
    "1a7ec5d1-dcba-4ec7-8220-3c1ee490416b",
    "3b6ec9d2-dabc-5e67-1220-6coie490416b"
  ],
  "statuses": [
    "ACCEPTED_RISK",
    "REVOKED"
  ],
  "workspaceIds": [
    "0fe6c2f2-022d-48f7-8e7e-3244369445b0",
    "80ab14ae-c17d-4fd6-88d5-99bf13f0b7f0"
  ],
  "workspaceVisibilities": [
    "team"
  ]
}'

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

Returns all secrets detected by Postman’s Secret Scanner, grouped by workspace or resource. If you pass an empty request body, this endpoint returns all results.

Returns all secrets detected by Postman's [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/), grouped by workspace or resource. If you pass an empty request body, this endpoint returns all results.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

limitintegerOptionalDefaults to 10

The maximum number of rows to return in the response.

cursorstringOptional

The pointer to the first record of the set of paginated results. To view the next response, use the nextCursor value for this parameter.

includestringOptional

The additional fields to be included as a part of the request:

meta.total — Include the total records found in the meta response object.

The additional fields to be included as a part of the request: - `meta.total` — Include the total records found in the `meta` response object.

sincedatetimeOptional

Return only results created since the given time, in ISO 8601 format. This value cannot be later than the until value. To use time-numoffset format, you must use %2B URL-encoding for the + character.

Return only results created since the given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be later than the `until` value. To use `time-numoffset` format, you must use `%2B` URL-encoding for the `+` character.

untildatetimeOptional

Return only results created until this given time, in ISO 8601 format. This value cannot be earlier than the since value. To use time-numoffset format, you must use %2B URL-encoding for the + character.

Return only results created until this given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be earlier than the `since` value. To use `time-numoffset` format, you must use `%2B` URL-encoding for the `+` character.

Request

This endpoint expects an object.

resolvedbooleanOptional

If true, return secrets with a resolved status.

secretTypeslist of stringsOptional

A list of secrets types to query. For a list of valid IDs, use the GET /secret-types endpoint.

statuseslist of enumsOptional

A list of the types of resolution statuses to query.

Allowed values:

resourceslist of objectsOptional

A list of resources to query. If you use this query, you cannot also pass the workspaceIds query.

workspaceIdslist of stringsOptional

A list of workspaces IDs to query. If you use this query, you cannot also pass the resources query.

workspaceVisibilitieslist of enumsOptional

A list of workspace visibility settings to query. This currently supports the team and public settings.

Allowed values:

Response

Successful Response

metaobjectOptional

The response's meta information for paginated results.

datalist of objectsOptional

A list of detected secrets that match the search criteria.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error