For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/fr/api/latest/security-monitoring/list-findings.md. A documentation index is available at /llms.txt.
homeAccueildocsDocumentationapiAPI
Language
Datadog site

Énumérer les findings

WARNINGNote: This endpoint uses the legacy security findings data model and is planned for deprecation. Use the search security findings endpoint, which is based on the new security findings schema, to search security findings. If you have any feedback, contact Datadog support.
GEThttps://api.datadoghq.com/api/v2/posture_management/findingshttps://api.us3.datadoghq.com/api/v2/posture_management/findingshttps://api.us5.datadoghq.com/api/v2/posture_management/findingshttps://api.datadoghq.eu/api/v2/posture_management/findingshttps://api.ap1.datadoghq.com/api/v2/posture_management/findingshttps://api.ap2.datadoghq.com/api/v2/posture_management/findingshttps://api.uk1.datadoghq.com/api/v2/posture_management/findingshttps://api.ddog-gov.com/api/v2/posture_management/findingshttps://api.us2.ddog-gov.com/api/v2/posture_management/findings

Présentation

Récupérer une liste de résultats. Ceux-ci incluent à la fois les erreurs de configuration et les risques liés aux identités.

Remarque : pour filtrer et renvoyer uniquement les risques liés aux identités, ajoutez le paramètre de requête suivant : ?filter[tags]=dd_rule_type:ciem

Filtrage

Les filtres peuvent être appliqués en ajoutant des paramètres de requête à l'URL.

  • Utilisation d'un seul filtre : ?filter[attribute_key]=attribute_value
  • Chaînage de filtres : ?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...
  • Filtrage sur les tags : ?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2

Ici, attribute_key peut correspondre à l'une des clés de filtre décrites ci-dessous.

Les paramètres de requête de type integer prennent en charge les opérateurs de comparaison (>, >=, <, <=). Cela est particulièrement utile lors du filtrage par evaluation_changed_at ou resource_discovery_timestamp. Par exemple : ?filter[evaluation_changed_at]=>20123123121.

Vous pouvez également utiliser l'opérateur de négation sur les chaînes de caractères. Par exemple, utilisez filter[resource_type]=-aws* pour filtrer toutes les ressources non AWS.

L'opérateur doit être placé après le signe égal. Par exemple, pour filtrer avec l'opérateur >=, ajoutez l'opérateur après le signe égal : filter[evaluation_changed_at]=>=1678809373257.

Les paramètres de requête doivent uniquement faire partie des paramètres documentés et avoir des valeurs de types corrects. Les paramètres de requête dupliqués (par exemple filter[status]=low&filter[status]=info) ne sont pas autorisés.

Champs d'extension supplémentaires

Des champs d'extension supplémentaires sont disponibles pour certains résultats.

Les données sont disponibles lorsque vous incluez le paramètre de requête ?detailed_findings=true dans la requête.

Les champs suivants sont disponibles pour les résultats :

  • external_id : l'ID externe de la ressource liée au résultat.
  • description : la description et les étapes de remédiation pour le résultat.
  • datadog_link : le lien relatif Datadog pour le résultat.
  • ip_addresses : la liste des adresses IP privées de la ressource liée au résultat.

Réponse

La réponse inclut un tableau d'objets de résultats, des métadonnées de pagination et un décompte des éléments correspondant à la requête.

Chaque objet de résultat contient les éléments suivants :

  • L'ID du résultat, qui peut être utilisé dans une requête GetFinding pour récupérer les détails complets du résultat.
  • Les attributs principaux, notamment le statut, l'évaluation, les détails généraux de la ressource, l'état de mise en sourdine et les détails de la règle.
  • Les horodatages evaluation_changed_at et resource_discovery_date.
  • Un tableau de tags associés.

OAuth apps require the security_monitoring_findings_read authorization scope to access this endpoint.

Arguments

Chaînes de requête

Name
Type
Description
page[limit]
integer

Limit the number of findings returned. Must be <= 1000.

Default: 100
snapshot_timestamp
integer

Return findings for a given snapshot of time (Unix ms).

page[cursor]
string

Return the next page of findings pointed to by the cursor.

filter[tags]
string

Return findings that have these associated tags (repeatable).

filter[evaluation_changed_at]
string

Return findings that have changed from pass to fail or vice versa on a specified date (Unix ms) or date range (using comparison operators).

filter[muted]
boolean

Set to true to return findings that are muted. Set to false to return unmuted findings.

filter[rule_id]
string

Return findings for the specified rule ID.

filter[rule_name]
string

Return findings for the specified rule.

filter[resource_type]
string

Return only findings for the specified resource type.

filter[@resource_id]
string

Return only findings for the specified resource id.

filter[discovery_timestamp]
string

Return findings that were found on a specified date (Unix ms) or date range (using comparison operators).

filter[evaluation]
enum

Return only pass or fail findings.

Allowed enum values: pass, fail
filter[status]
enum

Return only findings with the specified status.

Allowed enum values: critical, high, medium, low, info
filter[vulnerability_type]
array

Return findings that match the selected vulnerability types (repeatable).

detailed_findings
boolean

Return additional fields for some findings.

Réponse

OK

The expected response schema when listing findings.

Champ
Type
Description
data [required]
[object]

Array of findings.

meta [required]
object

Metadata for pagination.

Exemple de code

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/posture_management/findings" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/posture_management/findings" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/posture_management/findings" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/posture_management/findings" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/posture_management/findings" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/posture_management/findings" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/posture_management/findings" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/posture_management/findings" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/posture_management/findings" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"