Get DB Sync Update Status

Xray REST APIs

Products

JFrog Xray

Content Type

REST API

ft:sourceType

Paligo

Description: Get the latest source update status.

Notes:DB Sync updates include updates for PublicData, Contextual Analysis or Exposure Sources.

Security: Requires a user with admin permissions

Usage: GET xray/api/v1/updates/getStatus

Consumes: None

Produces : application/json

Path Parameters: None

Query Parameters: None

Request Body: None

Response Body:

Name	Type	Description
last_updated	string	DB Sync V1: The timestamp of the last successful update. DB Sync V3: The timestamp of the latest update package The timestamp is in RFC 3339 format.
state	string	Sync process state Possible values: Depends on the environment and DB Sync version in use. JFrog SaaS environment: The returned state is always `normal` Self-Hosted environment: DB Sync V3: `normal`: Last DB Sync was successful, no DB Sync update is currently ongoing `running`: DBSync update is currently ongoing `failed`: Last DB Sync failed, no DB Sync update is currently ongoing DB Sync V1: `onboarding`: Before the onboarding DB sync was taken (No DB Sync update is currently ongoing) `normal`: After an onboarding DB Sync was done, no DB Sync update is currently ongoing `running`: DBSync update is currently ongoing `failed`: Last DB Sync failed, no DB Sync update is currently ongoing
sync_mode	string	Database update mode. Possible values: `online, offline` The default update mode is `online` and it changes to `offline` when an offline DB Sync is triggered.
status	string	Approximate progress indication. Format: `#%(#/#)`

Response Codes

Sample Successful Response:

{
  "last_updated": "2023-12-13T09:00:28.986Z",
  "state": "running",
  "sync_mode": "online",
  "status": "41% (80/192)"
}