Description: Start a Contextual Analysis scanning of a specific artifact.
Note: Only artifacts that are already scanned by Xray (for SCA - ‘regular’ scan) can be scanned.
Since: Xray 3.73.x
Security: Requires a valid user with the "Manage Xray Metadata" permission.
Usage: POST /xray/api/v1/artifact/contextualAnalysis/scan
Required Parameters
Parameter | Type | Mandatory/Optional | Description |
|---|---|---|---|
component_id | String | Mandatory | The Artifact component ID. |
path | String | Mandatory | The artifact path in the repository. |
Response Codes
Status Code | Description |
|---|---|
200 | OK |
400 | Bad request |
404 | Not found |
Sample Request
{
"component_id": "gav://log4j:log4j:1.2.17"repo": "my-repository",
"path": "path-to/manifest.json"
}Successful Response
200 OK
{}