Skip to main content
All self-hosted PowerSync Service instances ship with a Diagnostics API. This API provides the following diagnostic information:
  • Connections → Connected backend source database and any active errors associated with the connection.
  • Active Sync Streams / Sync Rules → Currently deployed Sync Streams (or legacy Sync Rules) and its status.

​
CLI

If you have the PowerSync CLI installed, use powersync status to check instance status without calling the API directly. This works with any running PowerSync instance — local or remote. 
powersync status

# Extract a specific field
powersync status --output=json | jq '.connections[0]'

​
Diagnostics API

​
Configuration

  1. To enable the Diagnostics API, specify an API token in your PowerSync YAML file:
powersync.yaml
api:
  tokens:
    - YOUR_API_TOKEN
Make sure to use a secure API token as part of this configuration
  1. Restart the PowerSync Service.
  2. Once configured, send an HTTP request to your PowerSync Service Diagnostics API endpoint. Include the API token set in step 1 as a Bearer token in the Authorization header. 
curl -X POST http://localhost:8080/api/admin/v1/diagnostics \
  -H "Authorization: Bearer YOUR_API_TOKEN"