Skip to content

Admin API

The admin API is for building management tools — apps like the Wish Dashboard that control identities, connections, discovery, and app permissions.

Regular apps don't need these endpoints. They work within the sandbox: identities are granted to them, contacts are made visible, and connections are managed by wish-core. See the App API for what regular apps use.

Requesting admin access

typescript
const app = new App({
    name: 'MyAdminTool',
    protocols: ['mytool'],
    permissions: { admin: true },
});

Admin access must be approved in the Wish app. Without it, admin endpoints return 403 Admin permission required.

Endpoint categories

  • Identity — create, update, remove, export, signers, contacts, contact requests, join mode
  • Connections — connection management, relay servers, host configuration
  • Discovery — nearby (local network), DHT (internet)
  • Apps — identity grants, contact visibility, admin privileges