Skip to content

Commit 455757b

Browse files
Copilotruslanbaidan
andcommitted
Update README with API documentation section
Co-authored-by: ruslanbaidan <3246171+ruslanbaidan@users.noreply.github.com>
1 parent deea371 commit 455757b

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,25 @@ For installation instructions see
4646

4747
You can also use the provided [Virtual Machine](https://vm.monarc.lu).
4848

49+
API Documentation
50+
-----------------
51+
52+
MONARC provides a comprehensive RESTful API for programmatic access. The API is documented using OpenAPI 3.0 (Swagger) specification.
53+
54+
- **View API Documentation**: Navigate to `/swagger-ui.html` in your MONARC installation
55+
- **OpenAPI Specification**: Available at `/swagger.yaml`
56+
- **Documentation Guide**: See [public/API_DOCUMENTATION.md](public/API_DOCUMENTATION.md)
57+
58+
The API allows you to:
59+
- Manage risk analyses (ANR)
60+
- Handle assets, threats, and vulnerabilities
61+
- Manage risks and operational risks
62+
- Create and track recommendations
63+
- Generate reports and exports
64+
- And much more...
65+
66+
Authentication is token-based. See the API documentation for details on obtaining and using authentication tokens.
67+
4968

5069
Contributing
5170
------------

0 commit comments

Comments
 (0)