This page documents non-public platform-level APIs used by internal infrastructure, deployment automation, and third-party integrations.
Catalog API provides connection details for assigned DB roles on a host. This API is important for third-party services and custom integrations.
Use case: External tools, backup systems, reporting services, and other infrastructure components use Catalog API to discover and connect to instance database roles.
Access: Restricted by deployment configuration. Typically accessible from internal/trusted infrastructure.
Note: This is the recommended API for third-party service integration when you need programmatic access to instance connection details.
Internal API is used for internal platform orchestration and node management.
Typical responsibilities:
Security boundary:
Gateway API and Node API (see Gateway API) are used by internal automation to generate and synchronize routing configuration for Nginx in distributed deployments.
Purpose:
Intended consumer:
Deployment notes:
For public API access, use JSON-RPC API.
For third-party service integration with connection details, use Catalog API (documented above).