Practice

XRAY: Offline Rest API of Xray SCA DB Sync

AuthorFullName__c
Jian Sun
articleNumber
000005954
FirstPublishedDate
2024-01-04T12:09:38Z
lastModifiedDate
2024-12-20
VersionNumber
2

The complete process consists of the following steps:

1.  Get the jf command from the Rest API, then run the command to download the offline sync files

$ curl http://xx:xx/xray/api/v1/updates/generateDownloadCommand -XGET  -uadmin:'xx'
{"snippet":"jf xr offline-update --license-id=xx xxxx xxxx"}


2.  Copy the files the "jf" client downloaded to these folders (Xray <=3.79.11)

$ {JFROG_HOME}/xray/data/updates/component
$ {JFROG_HOME}/xray/data/updates/vulnerability

Note: If you are using the new V3 DB Sync method, use this path instead:

${XRAY_HOME}/var/work/server/updates/v3


3.  Invoke the "Sync Now" Xray Rest API

$ curl http://xx:xx/xray/api/v1/updates/startOfflineSync -XPOST  -uadmin:'xx'
{"info":"Local updates started"}


4.  Get progress by UI
User-added image