Try JFrog
API Reference
Contact SupportTry JFrog
  1. Xray REST APIs
  2. Import Export V1

Export Xray Configuration

post
https://jf.example.com/xray/api/v1/configuration/export

Exports selected Xray user-defined settings to a ZIP file under {XRAY_HOME}/var/work/server/backup/config/. The ZIP is named {SERVICE_ID}_xray_exported_config_{TIMESTAMP}.zip.

Dependencies between exported items:

  • Exporting watches requires exporting policies.

  • Exporting ignore rules requires exporting watches.

Set export_all to true to export every supported configuration type. When export_all is false, at least one configuration flag must be set to true; otherwise no ZIP is written and the response reports that nothing was found to export.

Available for Self-Hosted installation only, not in JFrog SaaS. Requires an admin user. Supported from Xray 2.11.0.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean

When true, export all supported configuration types. Default: false.

boolean

Export policies. Default: false.

boolean

Export watches. Requires policies to be exported as well. Default: false.

boolean

Export ignore rules. Requires watches (and therefore policies) to be exported as well. Default: false.

boolean

Export custom licenses. Default: false.

boolean

Export custom issues. Default: false.

boolean

Export webhooks. Default: false.

boolean

Export custom integrations. Default: false.

boolean

Export indexed resources. Default: false.

boolean

Export ticketing integrations and profiles. Default: false.

boolean

When true, encrypt the contents of exported JSON files inside the ZIP. Default: false.

Responses

Updated about 1 hour ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago

Did this page help you?