---
updatedAt: 2026-08-03T08:23:22.000Z
agentTools:
  siteIndex: https://docs.jfrog.com/llms.txt
  projectIndex: https://docs.jfrog.com/security/llms.txt
---

# Export Xray Configuration

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.


# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Xray REST APIs",
    "description": "Combined JFrog Xray REST API specification (all endpoints).",
    "version": "3.140"
  },
  "servers": [
    {
      "url": "https://jf.example.com/xray",
      "description": "JFrog Platform (Xray)"
    }
  ],
  "security": [
    {
      "basicAuth": []
    }
  ],
  "paths": {
    "/api/v1/configuration/export": {
      "post": {
        "operationId": "export-xray-configuration",
        "summary": "Export Xray Configuration",
        "description": "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`.\n\nDependencies between exported items:\n\n- Exporting watches requires exporting policies.\n\n- Exporting ignore rules requires exporting watches.\n\nSet `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.\n\nAvailable for Self-Hosted installation only, not in JFrog SaaS. Requires an admin user. Supported from Xray 2.11.0.\n",
        "tags": [
          "Import Export V1"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "export_all": {
                    "type": "boolean",
                    "description": "When true, export all supported configuration types. Default: false.\n"
                  },
                  "policies": {
                    "type": "boolean",
                    "description": "Export policies. Default: false."
                  },
                  "watches": {
                    "type": "boolean",
                    "description": "Export watches. Requires policies to be exported as well. Default: false.\n"
                  },
                  "ignore_rules": {
                    "type": "boolean",
                    "description": "Export ignore rules. Requires watches (and therefore policies) to be exported as well. Default: false.\n"
                  },
                  "custom_licenses": {
                    "type": "boolean",
                    "description": "Export custom licenses. Default: false."
                  },
                  "custom_issues": {
                    "type": "boolean",
                    "description": "Export custom issues. Default: false."
                  },
                  "webhooks": {
                    "type": "boolean",
                    "description": "Export webhooks. Default: false."
                  },
                  "custom_integrations": {
                    "type": "boolean",
                    "description": "Export custom integrations. Default: false."
                  },
                  "indexed_resources": {
                    "type": "boolean",
                    "description": "Export indexed resources. Default: false."
                  },
                  "ticketing_integrations": {
                    "type": "boolean",
                    "description": "Export ticketing integrations and profiles. Default: false.\n"
                  },
                  "encrypt_full_files": {
                    "type": "boolean",
                    "description": "When true, encrypt the contents of exported JSON files inside the ZIP. Default: false.\n"
                  }
                }
              },
              "example": {
                "export_all": false,
                "policies": true,
                "watches": true,
                "ignore_rules": true,
                "custom_licenses": false,
                "custom_issues": false,
                "webhooks": false,
                "custom_integrations": false,
                "indexed_resources": false,
                "ticketing_integrations": false,
                "encrypt_full_files": false
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Configuration exported successfully, or no matching configuration was found to export.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "info": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "info": "Successfully exported config to file xray@000_xray_exported_config_1710000000.zip under {XRAY_HOME}/var/work/server/backup/config/"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request. Common causes include an empty body, exporting watches without policies, or exporting ignore rules without watches.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "error": "Policies must be exported with Watches"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "500": {
            "description": "Failed to export configuration.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "error": "Failed to export config"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Basic authentication using username/password or API key"
      }
    }
  },
  "tags": [
    {
      "name": "Import Export V1",
      "description": "APIs for exporting and importing Xray user-defined configuration (policies, watches, ignore rules, and related settings) as a ZIP file.\n"
    }
  ]
}
```