Skip to content

Conversation

@michaelbarnes
Copy link
Contributor

@michaelbarnes michaelbarnes commented Jan 6, 2026

Summary

This is a lengthy PR and introduces docs for the PowerSync Cloud Management APIs

Changes

New Files:

  • resources/cloud-management-apis.mdx - Overview page with authentication setup, common parameters, and quick reference tables
  • resources/cloud-management-apis/cloud-management-endpoints.mdx - Detailed endpoint documentation with request/response examples

Updated Files:

  • docs.json - Added new "Cloud Management APIs" navigation group under Resources

Documentation Coverage

Instance Management Endpoints:

  • List, Create, Deploy, Destroy, and Deactivate instances
  • Get instance configuration, status, and diagnostics
  • Trigger storage compaction

Development & Debug Endpoints:

  • Test database connections (PostgreSQL, MongoDB, MySQL)
  • Retrieve database schema
  • Validate and reprocess sync rules

General Endpoints:

  • List available regions and IP addresses
  • List available service versions by channel

Reporting Endpoints:

  • Get currently connected clients
  • Get detailed connection analytics with pagination

Logs API

  • Get api or replicator logs for a PowerSync Cloud instance

###Additional Details

  • Includes authentication guide using Personal Access Tokens (PAT)
  • Documents connection configuration for all supported databases (PostgreSQL, MongoDB, MySQL)
  • Provides curl examples for every endpoint
  • Includes example request/response payloads in collapsible accordions
  • Documents Supabase-specific authentication configuration

Testing

A script was created that called each of the API endpoints using a Test PowerSync Cloud Account

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants