API Documentation

This API provides operations for managing profiles and groups in the GemAutomate system. It allows users to create, retrieve, and manipulate profiles and groups.

Server: http://localhost:1010

Version

Operations related to versions of browsers.

GET  /api/browser_versions

Code 200 A successful response containing a list of browser versions. Code 500 Server error, when unable to fetch data from the external service.

Groups

Operations related to groups

GET  /api/groups

Code 200 Successful operation, returns a list of groups Code 500 Server error

Profile

Operations related to profiles

GET  /api/profiles/delete/{id}

Code 200 Successful operation, profile deleted Code 404 Profile not found Code 500 Server error

GET  /api/profiles/start/{id}

Code 200 Profile successfully started Code 400 Invalid request parameters Code 404 Profile not found Code 500 Internal server error

GET  /api/profiles/close/{id}

Code 200 Browser successfully closed and profile status updated Code 404 Profile not found Code 500 Internal server error

POST  /api/profiles/update/{profile_id}

Code 200 Profile updated successfully Code 400 Bad request, possibly invalid input data Code 404 Profile not found Code 500 Internal server error

POST /api/profiles/create

Code 200 Profile created successfully Code 400 Bad request, possibly invalid input data Code 500 Internal server error

GET  /api/profile/{id}

Code 200 Profile retrieved successfully Code 404 Profile not found Code 500 Internal server error

GET  /api/profiles

Code 200 Profiles retrieved successfully Code 500 Server error

GET  /api/profiles/changeFingerprint

Code 200 Fingerprints updated successfully Code 400 Invalid or missing profile IDs Code 404 Some profile IDs do not exist in the database Code 500 Server error

Scripts

Operations related to scripts

GET  /api/scripts

Code 200 Successfully retrieved scripts Code 500 Server error

POST  /api/scripts/execute/{id}

Code 200 Script executed successfully Code 400 Missing or invalid input Code 404 Script or profiles not found Code 422 Invalid parameter type Code 500 Server error

POST  /api/scripts/check-status/{id}

Code 200 Script status retrieved successfully Code 400 Missing or invalid input Code 404 Script or profile not found Code 500 Server error

POST  /api/scripts/kill-execute/{id}

Code 200 Script execution terminated successfully Code 400 Missing script ID Code 404 Script not found Code 500 Server error