Envoyer des données à l'aide de l'API de données de sécurité

Envoyez des vulnérabilités personnalisées ou des données de sécurité à New Relic via notre API de données de sécurité via une simple requête POST. Utilisez l'API si nous ne prenons pas actuellement en charge votre service de sécurité avec une intégration ou si l'envoi de données de sécurité via une API correspond mieux à votre workflow personnalisé.

Prérequis

New Relic pour le compte auquel vous souhaitez signaler des données.

Envoyer des données à New Relic

Pour envoyer des vulnérabilités ou d'autres données de sécurité, envoyez un objet JSON via la méthode POST contenant un éventail de résultats. Chaque objet de l'éventail décrit une vulnérabilité détectée ou un autre événement de sécurité. Assurez-vous d'inclure le point de terminaison de sécurité pour New Relic. Utilisez l'un des éléments suivants en fonction de votre région :

Pour les États-Unis, https://security-api.newrelic.com/security/v1
Pour l'UE, https://security-api.service.eu.newrelic.com/security/v1

Voici un exemple de requête POST. Nous examinerons les composants individuels dans la section suivante :

bash

$curl -X POST https://security-api.newrelic.com/security/v1 \
>  -H "Content-Type: application/json" \
>  -H "Api-Key: INSERT_YOUR_API_KEY " \
>  -d '{
$    "findings": [
$        {
$            "source": "Insert security tool name, such as Snyk",
$            "title": "Insert a short description of security issue",
$            "message": "Insert long description and remediation advice",
$            "issueType": "Insert Library|Container|Host Vulnerability",
$            "issueId": "Insert vulnerability identifier like CVE, CWE, CIS, etc.",
$            "issueVendorId": "Vendor-specific identifier if different from issueId",
$            "issueInstanceKey": "Insert the unique path to this instance of the issue",
$            "disclosureUrl": "Insert a URL to additional information on the issue",
$            "severity": "Insert CRITICAL|HIGH|MEDIUM|LOW|INFO",
$            "remediationExists": Insert boolean true | false (no quotation marks),
$            "remediationRecommendation": "Explain the action to take",
$            "detectedAt": "Insert timestamp when detected, in milliseconds since epoch",
$            "entityType": "Insert Host|Service|Repository|Image|AWS",
$            "entityLookupValue": "Insert a URL to find entity",
$            "entityGuid": "ABCDEFG",
$            "customFields": {
$                "sourceDetailInfo": "DecadeCoffee"
$            }
$        }
$    ]
$}'

Paramètres d'URL

paramètres	Description
`repository`	Facultatif : l'URL du référentiel pour l'application avec votre intégration.

Champs obligatoires

Les champs suivants sont obligatoires dans la demande :

Champ	Description
`source`	Le nom convivial de l'outil de sécurité qui a généré cet événement tel que `Snyk` ou `Dependabot`.
`title`	Un bref résumé (50 à 100 caractères) du problème. Devrait convenir à une utilisation comme titre de page ou comme contenu de cellule de tableau.
`message`	Description détaillée du problème, y compris l’explication du résultat et la manière d’y remédier. Peut inclure une réduction.
`issueType`	Un type de problème pris en charge par New Relic. Actuellement, ce sont : `Library Vulnerability` `Container Vulnerability` `Host Vulnerability`
`issueId`	Un identifiant standard pour le problème détecté. Par exemple, l'identifiant CVE ou CWE, ou la règle critères CIS. Si plusieurs outils détectent le même problème, le `issueId` doit être le même pour tous les outils.
`severity`	Le consensus communautaire défini sur la gravité du problème ou de l’outil d’analyse. Cela devrait être l'un des suivants : `CRITICAL` `HIGH` `MEDIUM` `LOW` `INFO`
`entityType`	Utilisé pour corréler un problème signalé à une entité connue de la plateforme New Relic. Doit être l'un des types reconnus par l'API de recherche d'entité, ou des cas particuliers pris en charge par l'API de sécurité (`Image` et `AWS`). Un exemple avec `entityLookupValue` serait : `"entityType": "AWS", "entityLookupValue": "arn:aws:rds:us-east-2:403720000000:db:my-database"`
`entityLookupValue`	Utilisé pour trouver l'entité appropriée de ce type. Un exemple avec `entityType` serait : `"entityType": "Repository", "entityLookupValue": "https://github.com/newrelic/ruby_agent"`
`entityGuid`	Un identifiant unique pour une entité spécifique au sein de la plateforme New Relic, essentiel pour le suivi et la gestion des applications, des services ou des composants d'infrastructure. Un exemple de `entityGuid` serait : `"entityGuid": "MTI1NjM5fEFQfEFQUExJQ0FUSU9OfDEyMzQ1Njc4OQ"`

Champs optionnels

Votre demande peut contenir l'un des champs facultatifs suivants :

Champ	Description
`cvssScore`	Le score CVSSv3 attribué au CVE, sous forme de nombre à virgule flottante au format JSON/
`cvssVector`	Le vecteur CVSSv3 décrivant ce CVE.
`issueInstanceKey`	Un chemin ou un identifiant qui identifie de manière unique l'occurrence de cette instance des vulnérabilités à partir d'une autre instance dans le même référentiel (référentiel), service, entité ou compte. Par exemple : chemin complet vers un fichier plus le numéro de ligne pour une recherche de code source, ou chemin vers un binaire vulnérable sur un hôte ou dans une image de conteneur. La clé instance doit être identique pour les résultats répétés du même problème tout en différenciant plusieurs instances nécessitant chacune une correction. S'il n'est pas fourni, le `entityGuid` résolu ou `entityLookupValue` fourni par l'utilisateur est utilisé.
`issueVendorID`	Identifiant spécifique au fournisseur pour le problème, s'il est différent de `issueId`.
`disclosureUrl`	Une URL vers des informations supplémentaires sur le problème, provenant soit du site Web du fournisseur de l'outil source, soit de références de divulgation publique. Cela devrait être une source fiable.
`remediationExists`	Booléen indiquant si un correctif pour le problème existe.
`remediationRecommendation`	Texte court expliquant les mesures à prendre pour remédier au problème. Pour les dépendances de tiers, utilisez le formulaire `upgrade PACKAGE_NAME to X.Y.Z`
`detectedAt`	Horodatage du moment où le problème a été détecté, en millisecondes depuis l'époque. Si elles ne sont pas fournies, nous utilisons le moment où les données sont envoyées à New Relic.