RESTKDocs

Configuration

Customize RESTK settings including appearance, proxy, timeouts, and keyboard shortcuts.

4 min read

RESTK is designed to work out of the box, but you can customize many aspects of the application to match your workflow.

Platform Availability

RESTK is currently available for macOS. Windows support is coming soon.

Opening Settings

Open Preferences

Navigate to RESTK > Settings from the menu bar, or press Cmd+,.

Browse Categories

Settings are organized into categories: Request, Response, Tabs, Scripts, Appearance, Keyboard Shortcuts, Data & Sync, AI Integration, Logs, Debug, and Design System.

Apply Changes

Most changes take effect immediately. Settings that require a restart display a notification.


Appearance

RESTK supports three theme modes to match your working environment.

SettingOptionsDefault
ThemeLight, Dark, SystemSystem
Font SizeSmall (0.85x), Normal (1.0x), Medium (1.05x), Large (1.1x)Normal (1.0x)
Font FamilySystem, Monospace, RoundedSystem
Accent ColorViolet, Blue, Purple, Pink, Red, Orange, Yellow, Green, Teal, Indigo, GrayViolet

System Theme

When set to System, RESTK follows your operating system's light/dark mode preference automatically and switches in real time.


Proxy Configuration

If your organization uses a proxy server, configure RESTK to route requests through it.

HTTP/HTTPS Proxy

Enable Proxy

Go to Settings > Proxy and toggle Use Proxy on.

Enter Proxy Details

Fill in the proxy host, port, and optionally username and password.

Configure Bypass List

Add domains that should bypass the proxy (e.g., localhost, *.internal.company.com). Wildcard patterns are supported.

FieldExampleDescription
Proxy Hostproxy.company.comProxy server hostname
Proxy Port8080Proxy server port
UsernamejdoeProxy auth username (optional)
Password********Proxy auth password (optional)
Bypass Listlocalhost, 127.0.0.1, *.localComma-separated domains to bypass

SOCKS Proxy

RESTK also supports SOCKS5 proxies. Select SOCKS5 from the proxy type dropdown and provide the host and port.


SSL/TLS Settings

Coming Soon

SSL certificate validation controls and client certificate (mTLS) support are planned for a future release. Currently, RESTK uses standard system SSL validation for all HTTPS requests.


Keyboard Shortcuts

RESTK includes a built-in keyboard shortcuts reference. You can view all available shortcuts in Settings > Keyboard Shortcuts.

Common Shortcuts

ActionShortcut
New Request TabCmd+T
Send RequestCmd+Enter
Focus URL BarCmd+L
Toggle SidebarCmd+B
Open SettingsCmd+,
Close TabCmd+W
Switch EnvironmentCmd+E
Search CollectionsCmd+K
Toggle ConsoleCmd+Shift+C
Format BodyCmd+Shift+F

Fixed Shortcuts

Keyboard shortcuts are currently fixed and cannot be customized. The shortcuts reference in Settings is informational only.


Data Storage

RESTK stores all data locally on your machine in a fixed location.

Storage Location

PlatformPath
macOS~/Library/Application Support/restk/

What Is Stored Locally

  • Collections and requests: All your API collections, folders, and request definitions
  • Environments: Variable definitions and values
  • History: Request/response history (manual clearing only)
  • Preferences: Application settings
  • Credentials: Encrypted authentication credentials stored in macOS Keychain

Fixed Storage Path

The storage location is fixed and cannot be changed. This ensures data integrity and avoids conflicts with cloud-synced folders.


Performance Settings

Fine-tune network behavior for your testing needs.

SettingDescriptionDefault
Request TimeoutMaximum time to wait for a response30s
Connection TimeoutMaximum time to establish a connection30s
Max RedirectsMaximum number of HTTP redirects to follow5
Follow RedirectsAutomatically follow 3xx redirectsEnabled
Max Response SizeMaximum response body size to display50 MB

RESTK supports three timeout types — connection, request, and total — each configurable from 1 second to 900 seconds (15 minutes). For slow APIs or large file uploads, increase the request timeout.

Response Size Limit

Responses larger than the configured limit are saved to disk and a preview is shown in the response panel. You can always download the full response file.


Next Steps