REST API

As an API-first platform, every functionality available on the Syndeia Web Dashboard is first made available via the Syndeia Cloud REST API. Syndeia Web Dashboard, Syndeia SysML plugins, and Standalone clients are the first consumers of the Syndeia Cloud REST API. The same REST API is made available to Syndeia users. New and existing repository integrations are now part of Syndeia Cloud 3.6 and made available via the Syndeia Cloud REST API. The API is specified using OpenAPI Specification 3.0 (OAS3) and available as a Swagger doc accessible from the Syndeia Web Dashboard.

Sign in to the Syndeia Cloud Web Dashboard and check the main menu on the LHS. Click on the Help icon, as shown below.


The following pages describe the contents accessible via the API - Overview and API - Swagger doc sub-menus.