Skip to main content

Swagger API Documentation

Cirata Symphony provides an interactive Swagger UI for exploring and testing both platform and extension API endpoints.

Accessing Swagger​

The Swagger UI is available within a running Symphony instance through the Help menu, under Access > Swagger (at https://your-symphony-instance.com/help/access/swagger).

The Swagger interface lets you:

  • Browse platform API endpoints (health, authentication, API keys, admin) and extension endpoints from all connected extensions
  • View request and response schemas for every endpoint
  • Test API calls directly from the browser using "Try it out"
  • Generate example requests for your client code

Endpoint Grouping​

Endpoints are organised into collapsible sections by tag:

  • Platform endpoints are grouped by function—Health, Authentication, Extensions, API Keys, Admin - Roles, Admin - Settings, and Admin - Licensing
  • Extension endpoints are grouped by extension name (e.g. "datamigrator", "intelligence")—each extension's endpoints appear under its own heading

Authentication for "Try it out"​

When you execute a request using "Try it out", Symphony automatically handles authentication:

  • Platform endpoints use your current session token directly
  • Extension endpoints create a short-lived, scoped API key with just enough permissions to invoke extension services. This key expires after 5 minutes and is automatically cleaned up

No manual token entry is required.

info

The Swagger UI requires authentication. Log in to your Cirata Symphony instance first, then navigate to the Swagger page through the Help menu.