Skip to main content
CYPEX Documentation
Support
v2.0.0 Latest stable release View changelog ->

Internal API

1 min read

Data & Content → Internal API lets you explore and test the CYPEX backend’s own endpoints, rendered from its generated OpenAPI specification.

This screen is System Administrator only (system admin visibility).

Internal API vs REST API

CYPEX exposes two different HTTP surfaces. They are not interchangeable:

REST APIInternal API
What it exposesYour queries (database views), as PostgREST endpointsCYPEX platform endpoints — administration, authentication, connectors, audit
Who it is forApplications and external consumers of your dataPlatform administration
Access controlPostgreSQL grants and Row-Level SecurityBackend authorization; System Administrator only
Where the spec comes fromGenerated by PostgREST from the exposed schemaGenerated from the backend’s OpenAPI specification

If you are integrating an external system with your CYPEX data, use the REST API. The Internal API is an administration and debugging surface.

See also