---
updatedAt: 2026-05-31T12:22:47.000Z
agentTools:
  siteIndex: https://docs.jfrog.com/llms.txt
  projectIndex: https://docs.jfrog.com/administration/llms.txt
---

# Export System

Export full system to a server local directory.

Since: 2.4.0

Security: Requires a valid admin user.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "JFrog Artifactory Import & Export API",
    "description": "REST API for importing and exporting repository content and system settings in JFrog Artifactory. From version 5.10, Artifactory maintains any security entities (users, groups, permissions and tokens) when doing a system import.",
    "version": "1.0.0",
    "contact": {
      "name": "JFrog Support"
    }
  },
  "servers": [
    {
      "url": "https://{jfrog_url}/artifactory/api",
      "description": "JFrog Platform",
      "variables": {
        "jfrog_url": {
          "default": "myserver.jfrog.io",
          "description": "Your JFrog Platform hostname (e.g., mycompany.jfrog.io)"
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Export",
      "description": "Export operations"
    }
  ],
  "paths": {
    "/export/system": {
      "post": {
        "tags": [
          "Export"
        ],
        "summary": "Export System",
        "description": "Export full system to a server local directory.\n\nSince: 2.4.0\n\nSecurity: Requires a valid admin user.",
        "operationId": "exportSystem",
        "requestBody": {
          "description": "Export settings specifying the target path and export options.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExportSettings"
              },
              "examples": {
                "exportSystemSettings": {
                  "summary": "Export System",
                  "value": {
                    "exportPath": "/export/path",
                    "includeMetadata": true,
                    "createArchive": false,
                    "bypassFiltering": false,
                    "verbose": false,
                    "failOnError": true,
                    "failIfEmpty": true,
                    "m2": false,
                    "incremental": false,
                    "excludeContent": false
                  }
                }
              }
            },
            "application/vnd.org.jfrog.artifactory.system.ExportSettings+json": {
              "schema": {
                "$ref": "#/components/schemas/ExportSettings"
              },
              "examples": {
                "exportSystemSettings": {
                  "summary": "Export System",
                  "value": {
                    "exportPath": "/export/path",
                    "includeMetadata": true,
                    "createArchive": false,
                    "bypassFiltering": false,
                    "verbose": false,
                    "failOnError": true,
                    "failIfEmpty": true,
                    "m2": false,
                    "incremental": false,
                    "excludeContent": false
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Export status log as plain text.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    }
  },
  "security": [
    {
      "BasicAuth": []
    },
    {
      "ApiKeyAuth": []
    },
    {
      "BearerAuth": []
    }
  ],
  "components": {
    "schemas": {
      "ExportSettings": {
        "type": "object",
        "required": [
          "exportPath"
        ],
        "properties": {
          "exportPath": {
            "type": "string",
            "description": "The file system path to export to"
          },
          "includeMetadata": {
            "type": "boolean",
            "description": "Include metadata"
          },
          "createArchive": {
            "type": "boolean",
            "description": "Create archive"
          },
          "bypassFiltering": {
            "type": "boolean",
            "description": "Bypass filtering"
          },
          "verbose": {
            "type": "boolean",
            "description": "Verbose mode"
          },
          "failOnError": {
            "type": "boolean",
            "description": "Fail on error"
          },
          "failIfEmpty": {
            "type": "boolean",
            "description": "Fail if empty"
          },
          "m2": {
            "type": "boolean",
            "description": "Maven 2 format"
          },
          "incremental": {
            "type": "boolean",
            "description": "Incremental export"
          },
          "excludeContent": {
            "type": "boolean",
            "description": "Exclude content"
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "description": "Standard JFrog error envelope",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "integer",
                  "description": "HTTP status code"
                },
                "message": {
                  "type": "string",
                  "description": "Error message"
                }
              }
            }
          },
          "error": {
            "type": "string",
            "description": "Simple error message (legacy format)"
          }
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Bad Credentials - The provided authentication is invalid.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      },
      "Forbidden": {
        "description": "Permission Denied - Requires a valid admin user.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      },
      "InternalServerError": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "BasicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-JFrog-Art-Api"
      },
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false
  }
}
```