Cancel Artifact Contextual Analysis Scan

Xray REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Cancel an ongoing artifact Contextual Analysis scanning.

Note: Only artifacts that are in ‘pending’ status can be canceled.

Since: 3.75.x

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

Usage: POST /api/v1/artifact/contextualAnalysis/cancelScan

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.

Response Codes

Status Code

Description

200

OK

404

Not found

Sample Request

{
  "repo": "my-repository",
  "path": "path-to/manifest.json",
}

Sample Response

200 OK
{
  "info": "Scan Canceled"
}