Description: Start an Exposures scanning of a specific artifact.
Note: Only artifacts which 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 /api/v1/artifact/exposures/scan
Required Parameters
Parameter | Type | Mandatory/Optional | Description |
|---|---|---|---|
repo | string | Mandatory | The name of the repository of the artifact. |
path | string | Mandatory | The artifact path in the repository. |
categories | object<categories> | Mandatory | The Exposures categories to scan. |
categories
Parameter | Type | Mandatory/Optional | Description |
|---|---|---|---|
secrets | boolean | Optional | Scan Secrets category. Only available for Docker repositories. |
services | boolean | Optional | Scan Services category. Only available for Docker repositories. |
applications | boolean | Optional | Scan Applications category. Only available for Docker repositories. |
iac | boolean | Optional | Scan IaC category. Only available for Terraform Backend repositories. |
Response Codes
Status Code | Description |
|---|---|
200 | OK |
400 | Bad request |
404 | Not found |
Request:
{
"repo": "my-repository",
"path": "path-to/manifest.json",
"categories": {
"secrets": true,
"applications": true
}
}Successful Response:
200 OK
{
"info": "Exposures Scan Started"
}