Import Xray Configuration

Imports user-defined Xray configurations from a previously exported ZIP file (or an extracted directory) under the Xray backup config folder ({XRAY_HOME}/var/work/server/backup/config/).

Place the exported ZIP on the target server under that folder, then pass its relative path in src_path (for example xray@000_xray_exported_config_1710000000.zip). Absolute paths and paths containing .. are rejected.

Import dependencies mirror export:

  • Importing watches requires importing policies.

  • Importing ignore rules requires importing watches.

When async is true, the API returns immediately after starting the import and writes the result to a temporary import_results_* file next to the source path.

Requires an admin user.

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

Relative path to a ZIP file or directory under {XRAY_HOME}/var/work/server/backup/config/. Must not be blank, absolute, or contain ...

boolean

When true, run the import asynchronously and write results to an import_results_* file beside the source. Default: false.

Responses

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