https://github.com/mikebionic/server_mirror_api
Special api for handling data about working mirrors of apps
https://github.com/mikebionic/server_mirror_api
Last synced: 19 days ago
JSON representation
Special api for handling data about working mirrors of apps
- Host: GitHub
- URL: https://github.com/mikebionic/server_mirror_api
- Owner: mikebionic
- License: mit
- Created: 2021-06-10T11:54:32.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-08-12T07:41:17.000Z (11 months ago)
- Last Synced: 2025-08-12T09:27:45.462Z (11 months ago)
- Language: Python
- Size: 8.79 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Server Mirror API for Mobile & Desktop Apps
This API provides information about the active server mirrors for a given app. It is **required for mobile and desktop apps** to maintain reliable connectivity.
When one server becomes unreachable, the app automatically fetches the list of working server URLs (mirrors), so it can reconfigure itself without requiring:
* Rebuilding the app,
* Changing hardcoded URLs,
* Releasing app updates,
* Or forcing users to manually update their app.
This system improves reliability and user experience, especially in cases of connectivity loss or regional network issues.
## API Endpoint
| Path | Method |
| ------------------ | ------ |
| `/server-mirrors/` | GET |
---
## Query Parameters
| Name | Type | Description |
| ---- | ------ | ----------------- |
| app | string | The MirrorAppName |
---
## Example Request
```http
GET http:////server-mirrors/?app=AppName
```
---
## Example Response
```json
{
"data": [
{
"MirrorAppName": "AppName",
"MirrorDomainName": "domain.com",
"MirrorId": 1,
"MirrorIp": "192.168.1.1",
"MirrorIsActive": true,
"MirrorName": "App mirror Name",
"MirrorUrl": null,
"MirrorUrlPrefix": "/prefix",
"URL": "https://domain.com/prefix"
}
],
"message": "Server Mirrors of AppName",
"status": 1
}
```