Prepare an encrypted configuration export

POST

/api/system/configuration-export

curl --request POST \
  --url https://opfield.example.com/api/system/configuration-export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "passphrase": "example", "includeRegistry": false, "includeLogs": false }'

• Your Opfield instance

Returns a one-time download link (valid 15 minutes) that streams the encrypted export: database, environment with the master key, CA and signing keys, Opfield file volumes, and optionally the internal registry and managed logs. Nothing stops while it runs. Requires admin:system.

Authorizations

• bearerAuth

Request Body^required

JSON request body

Media typeapplication/json

object

passphrase

required

Passphrase that encrypts the export; at least 12 characters. Needed to restore it.

string

>= 12 characters <= 1024 characters

includeRegistry

Include the images of the internal registry.

boolean

includeLogs

Include the logs of the Opfield-managed ClickHouse.

boolean

Responses

200

Successful response

Media typeapplication/json

object

data

required

Resource object. Exact fields depend on the endpoint.

object

id

string

name

string

key

additional properties

Example

{
  "data": {
    "currentVersion": "1.2.3",
    "latestVersion": "1.2.4",
    "updateAvailable": true
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}