API-Doc

API Documentation for APTRS

About This API Collection

This repository contains the complete API documentation for APTRS (Automated Penetration Testing Reporting System) in Bruno format. The collection provides endpoints for all APTRS functionality organized by domain areas.

Using the Bruno Collection

To use this API collection:

1. Download and install Bruno - an open-source API client
2. Clone this repository: git clone <repository-url>
3. Open Bruno and use "Open Collection" to navigate to the cloned APTRS folder
4. Select the APTRS.bru environment file in the environments folder to configure your base URL and authentication

Collection Structure

The API collection is organized into the following main sections:

• Account - Authentication, user management, and profile operations
• Company - Company management and customer portal APIs
• Customer - Customer management operations
• Project - Project management, reports, scope, and vulnerability operations
• Config APIs - System configuration and status endpoints
• Vulnerability Database - Template and vulnerability data management

Contributing

To contribute to this API documentation:

1. Make your changes in Bruno
2. Export the collection (if needed)
3. Submit a pull request with your changes

Support

For questions about the API documentation or issues with the collection, please open an issue in this repository.