Skip to content

Configuration & Settings

Anes Berbic edited this page Mar 13, 2026 · 1 revision

Configuration & Settings

Access settings via Ctrl+, or the gear icon in the header.


General

Setting Description Default
Theme Light / Dark / Black (OLED) / System System
Accent Color 8 color presets Indigo
Language UI language English
Auto-save Auto-save requests after 1s of inactivity Enabled
Update Channel Stable / Beta / Nightly Stable

Network

Proxy Configuration

HTTP Proxy:  http://proxy.company.com:8080
HTTPS Proxy: http://proxy.company.com:8080
No Proxy:    localhost,127.0.0.1,.internal.com

Supports HTTP and SOCKS5 proxies. Configure per-collection or globally.

SSL/TLS

Setting Description Default
Verify SSL Verify server certificates On
Custom CA Bundle Path to CA certificate file System default

Warning: Disabling SSL verification is a security risk. Only disable for local development with self-signed certificates.

Client Certificates

For mutual TLS (mTLS) authentication:

Format Files Needed
PEM Certificate file (.pem) + Key file (.key)
PFX/PKCS12 Single .pfx file + passphrase

Configure in Settings → Certificates or per-collection in apiark.yaml:

defaults:
  tls:
    clientCert: /path/to/cert.pem
    clientKey: /path/to/key.pem
    # Or PFX:
    # pfx: /path/to/cert.pfx
    # passphrase: "{{certPassword}}"

Request Defaults

Setting Description Default
Timeout Request timeout in milliseconds 30000 (30s)
Follow Redirects Automatically follow HTTP redirects On
Max Redirects Maximum number of redirects to follow 10
Encode URL Auto-encode special characters in URLs On

Editor

Setting Description Default
Font Size Code editor font size 14px
Font Family Code editor font System monospace
Tab Size Spaces per tab 2
Word Wrap Wrap long lines On
Minimap Show minimap in code editor Off
Line Numbers Show line numbers On

Data & Storage

Setting Description Default
History Retention Days to keep request history 30
Max History Entries Maximum history entries 10000
Log Level Logging verbosity Info
Log Retention Days to keep log files 7

Storage Locations

Data Location
Settings ~/.apiark/settings.json
History ~/.apiark/data.db
Logs ~/.apiark/logs/
Window State ~/.apiark/state.json
Cookies ~/.apiark/cookies/
Crash Reports ~/.apiark/crash-reports/
License ~/.apiark/license.key
Trash ~/.apiark/trash/

Cookie Settings

Setting Description Default
Send Cookies Auto-send stored cookies On
Store Cookies Auto-store response cookies On
Persist Cookies Save cookies across sessions Off

Per-collection cookie settings override global settings. See Collections & YAML Format for details.


Privacy

Setting Description Default
Crash Reports Send anonymous crash reports Off
Usage Analytics Send usage statistics Off (always off)
Redact Secrets in History Replace auth tokens with [REDACTED] On

ApiArk collects zero data by default. See our Privacy Policy.


Settings File

All settings are stored in ~/.apiark/settings.json:

{
  "theme": "dark",
  "accentColor": "indigo",
  "locale": "en",
  "autoSave": true,
  "updateChannel": "stable",
  "network": {
    "proxy": {
      "http": "",
      "https": "",
      "noProxy": "localhost,127.0.0.1"
    },
    "ssl": {
      "verify": true,
      "caBundle": ""
    },
    "timeout": 30000,
    "followRedirects": true,
    "maxRedirects": 10
  },
  "editor": {
    "fontSize": 14,
    "tabSize": 2,
    "wordWrap": true,
    "minimap": false
  },
  "privacy": {
    "crashReports": false,
    "redactSecrets": true
  }
}

You can edit this file directly — changes are picked up on next app launch.


Backup & Restore

Export Settings

Settings → Backup → Export App State

Exports a .zip containing:

  • settings.json
  • state.json (window layout, open tabs)
  • data.db (history, optional)

Import Settings

Settings → Backup → Import App State

Merges imported settings with existing ones. History can be replaced or merged.

Sync Across Machines

No built-in sync. Options:

  1. Export/Import .zip files
  2. Symlink ~/.apiark/settings.json to a cloud-synced folder
  3. Version settings.json in a dotfiles Git repo

Clone this wiki locally