REST APIs

Before you Start

🔥 This feature is currently considered experimental. Try it out and give feedback by reporting bugs and suggesting new features. It’s not recommended for production use.

💻 This feature is available to developers.

Use this page to explore the REST endpoints provided by Sirius Web. They are best suited for integration with other tools using the SysML v2 REST API.

1. Endpoint prefix

All endpoints start with /api/rest/. For example:

  • /api/rest/projects – list projects.

  • /api/rest/projects/projectId – manage a specific project.

2. OpenAPI and Swagger UI

Sirius Web ships with generated OpenAPI documentation. Open http://<host>:<port>/swagger-ui/index.html in your deployment to browse all endpoints interactively. You can also export the specification from /_/attachments/sirius-web-openapi.json.

The Swagger UI embedded in the documentation disables “Try it out” by default. Use your local instance if you want to test requests directly in a browser.

3. Supported endpoints

Highlights include:

  • Projects: create, list, delete projects; import/export models.

  • Object: manage objects within projects.

4. Usage tips

  • For advanced interactions, consider the GraphQL API instead.

  • When uploading files, set the correct Content-Type (typically application/json for models).

  • Combine the REST API with automation scripts (shell, Python, CI runners) to bootstrap workspaces.