Docs › REST API

API reference

|

The local REST API exposes 28 endpoints across profiles, groups, tags, proxies, VPNs, and browsers. All requests require a bearer token — see Authentication.

Base URL

Default: http://127.0.0.1:10108/v1. Configure host and port in Settings → Integrations → Local API.

Endpoints

Representative endpoints:

  • GET /v1/profiles — List profiles
  • POST /v1/profiles — Create profile
  • GET /v1/profiles/{id} — Get profile
  • PATCH /v1/profiles/{id} — Update profile metadata
  • DELETE /v1/profiles/{id} — Delete profile
  • POST /v1/profiles/{id}/run — Launch browser (Pro)
  • POST /v1/profiles/{id}/open-url — Open URL in running profile (Pro)
  • GET /v1/groups — List profile groups
  • GET /v1/proxies — List stored proxies
  • GET /v1/vpns — List VPN configs
  • GET /v1/browsers — List installed browser engines

Example

curl -sS http://127.0.0.1:10108/v1/profiles \
  -H "Authorization: Bearer $DONUT_API_KEY"

Full machine-readable spec: OpenAPI spec or GET /openapi.json on the local server.