Create Issue Event

Xray REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Allows adding a custom issue

API Version: v1

Security: Requires a valid user with the "Manage Xray Metadata" permission

Note: "id" parameter cannot have a prefix "Xray", and "provider" parameter cannot be JFrog.

Usage: POST /api/v1/events

Produces: application/json

Consumes: application/json

Sample Payload:

{
    "id": "IMP-ISSUE-787",
    "type": "Security",
    "provider": "sec-dep",
    "package_type": "maven",
    "severity": "High",
    "components": [
        {
            "id": "aero:aero",
            "vulnerable_versions": [
                "[0.2.3]"
            ]
        }
    ],
    "cves": [
        {
            "cve": "CVE-2017-1000386",
            "cvss_v2": "2.4"
        }
    ],
    "summary": "A very important custom issue",
    "description": "A very important custom issue",
    "sources": [
        {
            "source_id": "CVE-2017-1000386"
        }
    ]
}

Sample Response:

{
    "id": "IMP-ISSUE-787",
    "package_type": "maven",
    "type": "security",
    "provider": "sec-dep",
    "summary": "A very important custom issue",
    "description": "A very important custom issue",
    "severity": "High",
    "created": "2019-12-17T15:29:31.95835098Z",
    "cves": [
        {
            "cve": "CVE-2017-1000386",
            "cvss_v2": "2.4"
        }
    ],
    "sources": [
        {
            "source_id": "CVE-2017-1000386"
        }
    ],
    "components": [
        {
            "id": "aero:aero",
            "vulnerable_versions": [
                "[0.2.3]"
            ],
            "fixed_versions": null
        }
    ],
    "modified": "2019-12-17T15:29:31.95835098Z",
    "edited": "2019-12-17T15:29:31.972920491Z"
}