Repository Scan Status

Xray REST APIs

Products
JFrog Xray
Content Type
REST API

Description: Returns the scan status summary for a repository.

Since: 3.122

Applicable Environment: JFrog SaaS, JFrog Self-Hosted

Security: Requires a valid user with Read permissions.

UsageGET /xray/api/v1/metrics/repo/status

Consumes: application/json

Produces: application/json

Query Parameters:

Name

Type

Required/Optional

Description

repo

string

required

The repository key (e.g., devPython-local).

Response Body:

Parameter

Type

Description

timestamp

string

RFC 3339 timestamp (may include nanoseconds) when the metrics were generated.

data

DataObj

List of status buckets with counts.

DataObj:

Parameter

Type

Description

status_name

string

Scan status bucket.

Possible values:

  • NOT_SUPPORTED

  • NOT_SCANNED

  • PENDING

  • SCANNING

  • DONE

  • PARTIAL

  • FAILED

count

integer

Number of artifacts in this status for the repository.

Response Codes:

Status

Description

200

Successful response

400

Bad request

403

Permission denied

404

Repository not found

500

Internal server error

Sample Response:

200 OK
{
  "timestamp": "2025-05-25T11:37:54.092340456Z",
  "data": {
    "items": [
      {
        "status_name": "DONE",
        "count": 43
      },
      {
        "status_name": "SCANNING",
        "count": 3
      }
    ]
  }
}