Skip to main content
System endpoints provide information about Zerobyte capabilities, available updates, and system-wide configuration.

​
Get System Info

curl -X GET http://localhost:4096/api/v1/system/info \
  -H "Cookie: zerobyte.session=..."
Retrieve system information and available capabilities. Response:
​
capabilities
object
System capabilities

​
Check for Updates

curl -X GET http://localhost:4096/api/v1/system/updates \
  -H "Cookie: zerobyte.session=..."
Check for available Zerobyte updates from GitHub releases. Response:
​
currentVersion
string
Current installed version
​
latestVersion
string
Latest available version
​
hasUpdate
boolean
Whether an update is available
​
missedReleases
array
Releases between current and latest

​
Get Registration Status

curl -X GET http://localhost:4096/api/v1/system/registration-status \
  -H "Cookie: zerobyte.session=..."
Check if new user registration is enabled. Response:
​
enabled
boolean
Whether registration is enabled

​
Set Registration Status

curl -X PUT http://localhost:4096/api/v1/system/registration-status \
  -H "Cookie: zerobyte.session=..." \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": false
  }'
Enable or disable new user registration. Requires global admin role. Request Body:
​
enabled
boolean
required
Whether to enable registration
Response:
​
enabled
boolean
Updated registration status

​
Download Restic Password

curl -X POST http://localhost:4096/api/v1/system/restic-password \
  -H "Cookie: zerobyte.session=..." \
  -H "Content-Type: application/json" \
  -d '{
    "password": "your-account-password"
  }' \
  -o restic.pass
Download the organization’s Restic repository password for manual backup recovery. Requires organization admin role and password re-authentication. Important: This password is used to encrypt all repositories. Store it securely for disaster recovery. Request Body:
​
password
string
required
Your account password for verification
Response:
  • Success (200): Plain text file containing the Restic password
  • Error (401): Invalid password
  • Error (404): Restic password not found for organization
  • Error (500): Failed to retrieve password
The response includes a Content-Disposition header with filename restic.pass.

​
Get Dev Panel Status

curl -X GET http://localhost:4096/api/v1/system/dev-panel \
  -H "Cookie: zerobyte.session=..."
Check if the developer panel is enabled. Response:
​
enabled
boolean
Whether dev panel is enabled
Note: The dev panel allows executing arbitrary Restic commands and should only be enabled in development environments. It can be activated with Meta+Shift+D when enabled.

​
Health Check

curl -X GET http://localhost:4096/api/healthcheck
Basic health check endpoint (does not require authentication). Response:
​
status
string
Always returns “ok”

Build docs developers (and LLMs) love

Get started for freeTalk to us