-
Notifications
You must be signed in to change notification settings - Fork 2
API documentation
All API endpoints are documented in the source code and accessible via Swagger (https://swagger.io/), which can be accessed on /doc
endpoint.
eg. http://localhost:5000/doc
API to work with ADB and execute adb commands remotely.
POST /api/v1/adb/command
Executes ADB command via local ADB
POST /api/v1/adb/shellCommand
Executes ADB shell command via local ADB
API for administration and debugging of MobileManager. Currently being created and refactored.
GET /api/v1/admin/repositories
Gets all repositories.
GET /api/v1/admin/restart
Restarts the MobileManager. [NOT-WORKING]
API to work with Appium - this API should not be accessed by outside users, only for debugging and emergencies.
GET /api/v1/appium
Gets all appium processes. [INTERNAL-ONLY]
POST /api/v1/appium
Create the specified appiumProcess. [INTERNAL-ONLY]
GET /api/v1/appium/{id}
Gets appium process the by the identifier. [INTERNAL-ONLY]
DELETE /api/v1/appium/{id}
Delete the specified appium process by id. [INTERNAL-ONLY]
API for collecting and management of Appium logs.
GET /api/v1/appium/log/{id}
Gets the appium log by device identifier.
DELETE /api/v1/appium/log/{id}
Delete the appium log by device identifier.
API for managment of MM configuration.
GET /api/v1/configuration
Gets internal configuration
PUT /api/v1/configuration
Update the internal configuration.
API for management of devices - both Android and iOS.
GET /api/v1/device
Gets all active devices.
POST /api/v1/device
Create the specified device.
GET /api/v1/device/{id}
Gets device the by identifier.
PUT /api/v1/device/{id}
Update the specified device.
DELETE /api/v1/device/{id}
Delete the specified device by id.
GET /api/v1/device/properties/{id}
Gets device properties the by identifier.
GET /api/v1/device/seleniumConfig/{id}
Gets device properties the by identifier.
POST /api/v1/device/{id}/restart
Restarts the device.
GET /api/v1/device/{id}/screenshot
Gets device screenshot the by identifier.
Collect internal logs from MobileManager. Allows specification of fulltext filter and number of lines to be returned.
GET /api/v1/log/filter
Gets last number of lines from MM log
API for management of applied reservations.
GET /api/v1/reservation/applied
Gets all applied reservations.
POST /api/v1/reservation/applied
Creates the specified reservation. [INTERNAL-ONLY]
GET /api/v1/reservation/applied/{id}
Gets the reservationApplied by identifier.
DELETE /api/v1/reservation/applied/{id}
Deletes the ReservationApplied.
API for management of reservations in the queue waiting to be applied.
GET /api/v1/reservation
Gets all Reservations.
POST /api/v1/reservation
Creates the reservation.
GET /api/v1/reservation/{id}
Gets the Reservation by identifier.
PUT /api/v1/reservation/{id}
Update the specified device.
DELETE /api/v1/reservation/{id}
Delete the specified reservation by id.