main-game-api (1.0.0)
Download OpenAPI specification:
The main game API for Sniperz.io
server_list
returns online game servers
path Parameters
| filter required | string Examples:
which type of servers to return |
Responses
Response samples
- 200
Content type
application/json
[- {
- "uuid": "4fb7ef4a-ad5c-4ec1-bbb0-6cb1ea5af3e5",
- "population": 5,
- "max_popuation": 81,
- "game_type": "FFA",
- "country_code": "PK",
- "city": "Karachi",
- "ip": "us-central.sniperz.io"
}
]publish_server
register a new server to the API
Request Body schema: application/json
server id and registration key
| uuid | string (uuid4) |
| registration_key | string (uuid4) |
Responses
Request samples
- Payload
Content type
application/json
{- "uuid": "4fb7ef4a-ad5c-4ec1-bbb0-6cb1ea5af3e5",
- "registration_key": "4fb7ef4a-ad5c-4ec1-bbb0-6cb1ea5af3e5"
}Response samples
- 201
Content type
application/json
{- "heartbeat_interval": 15000
}publish_server/heartbeat
update server information
Request Body schema: application/json
server object with registration key
| registration_key | string (uuid4) |
object (Server) |
Responses
Request samples
- Payload
Content type
application/json
{- "registration_key": "4fb7ef4a-ad5c-4ec1-bbb0-6cb1ea5af3e5",
- "server": {
- "uuid": "4fb7ef4a-ad5c-4ec1-bbb0-6cb1ea5af3e5",
- "population": 5,
- "max_popuation": 81,
- "game_type": "FFA",
- "country_code": "PK",
- "city": "Karachi",
- "ip": "us-central.sniperz.io"
}
}