Documentation / API View as Markdown Switch documentation
Browse documentation

Migrate from v1

API v1 is retired. Every /v1 route now returns 410 Gone; legacy keys cannot authenticate to the current API.

Migration checklist

  1. Create a new pw_v2_ key in the dashboard and choose the smallest required scope preset.
  2. Change the base URL to /v2.
  3. Read successful payloads from data and pagination from meta.next_cursor.
  4. Add Idempotency-Key to creations and actions.
  5. Replace toggle calls with explicit start or stop operations.
  6. Enable remote control locally with pwrp remote enable, or in the desktop app under Settings > Remote Control.
  7. Track asynchronous work through /operations or webhooks.

Behavior changes

API keys are managed in the dashboard. Remote actions require a current Portwarp client with remote control enabled locally.