Documentation / API View as Markdown Switch documentation
Browse documentation

Endpoint index

Account and catalog endpoints are documented here. Resource endpoints link to focused guides with request fields and examples.

GET /

GET/account:read

Returns the API version, current availability and canonical documentation URL.

GET /account

GET/accountaccount:read

Returns the account visible to the key, its plan and current limits.

Shell
curl https://api.portwarp.com/v2/account \
  -H "Authorization: Bearer $PORTWARP_API_KEY"

GET /account/usage

GET/account/usageaccount:read

Returns active and total tunnel counts plus bandwidth usage for today and the current month.

GET /nodes

GET/nodestunnels:read

Lists the locations available for tunnel placement. Use the returned id with POST /tunnels/{id}/move.

GET /presets

GET/presetstunnels:read

Lists game/application presets. Use id as game_preset_id when creating a tunnel.

GET /domains

GET/domainstunnels:read

Lists platform domains available for generated tunnel hostnames.

GET /scope-presets

GET/scope-presetsaccount:read

Lists permission presets and the scopes included in each one.

Resource guides

ResourceEndpointsGuide
Tunnels23Create, configure and control
Devices5Inspect and control
Operations2Track asynchronous actions
Webhooks7Subscribe and verify

For tooling and LLM ingestion, use the single-file Markdown reference or the OpenAPI 3.1 schema.