Endpoints
| Name | Description | Access | Response Type | Parameters |
|---|---|---|---|---|
| status | Display html page with server status | private | html | |
| statusView | Display html page displaying server status, plus session attributes, members and participants. | private | html | |
| statusEdit | Display html page with forms to edit server session attributes. | private | html | |
| sessionConfig | Display html page with forms to edit server session attributes. | private | html | |
| performance | Display html page with performance status | private | html | |
| api/help | Get list of all supported HTTP API methods | public | json | |
| api/version | Get information about server version | public | json | |
| api/performance | Get information about server performance | public | json | |
| api/list/all | Get all lists known to the server | public | json | |
| api/list/attributes | Get all attribute lists known to the server | public | json | |
| api/list/attributes/session | Get session attribute list | public | json | |
| api/list/attributes/member | Get member (player) attribute list | public | json | |
| api/list/attributes/participant | Get participant (car) attribute list | public | json | |
| api/list/events | Get event list | public | json | |
| api/list/vehicle_classes | Get vehicle class list, used by per-class multiplayer restrictions | public | json | |
| api/list/vehicles | Get vehicle list | public | json | |
| api/list/liveries | Get vehicle list, with all liveries included for each vehicle | public | json | |
| api/list/tracks | Get track list | public | json | |
| api/list/enums | Get all enum types referenced by various attributes | public | json | |
| api/list/enums/damage | Get damage enum values | public | json | |
| api/list/enums/damage_scale | public | none | ||
| api/list/enums/random_failures | public | none | ||
| api/list/enums/tire_wear | Get tire wear enum values | public | json | |
| api/list/enums/fuel_usage | Get fuel usage enum values | public | json | |
| api/list/enums/penalties | Get penalties enum values | public | json | |
| api/list/enums/game_mode | Get game mode enum values | public | json | |
| api/list/enums/allowed_view | Get allowed view enum values | public | json | |
| api/list/enums/weather | Get weather enum values | public | json | |
| api/list/enums/grid_positions | Get grid position enum values | public | json | |
| api/list/enums/pit_control | Get pit control enum values | public | json | |
| api/list/enums/livetrack_preset | public | none | ||
| api/list/enums/scheduledfcy | public | none | ||
| api/list/enums/online_rep | Get online reputation rank enum values | public | json | |
| api/list/flags | Get all flag types referenced by various attributes | public | json | |
| api/list/flags/session | Get session flags values (Flags is session attributes) | public | json | |
| api/list/flags/player | Get player flags values (RaceStatFlags in player attributes) | public | json | |
| api/log/overview | Get information about the number of events available in the log | private | json | |
| api/log/range | Get range of events from the log. Less events than requested might be returned, but event outside of the requested range will never be returned. | private | json | {
"name": "offset",
"type": "int",
"optional": false,
"description": "Index of the oldest event to return. If negative, count from the number of available events. So use first=-10 and count=10 to get 10 latest events, for example."
} { "name": "count", "type": "int", "optional": false, "description": "Number of events to return." } |
| api/session/advance | Advance the session to the next stage. | admin | json | |
| api/restart | Advance the session to the next stage. | admin | json | |
| api/session/kick | Kick and optionally temporary-ban specified session member | admin | json | {
"name": "refid",
"type": "int",
"optional": false,
"description": "RefId of the member to kick"
} { "name": "ban", "type": "int", "optional": true, "description": "Time of temporary ban from the server, in seconds" } |
| api/session/set_attributes | Request change of attributes from the game | admin | json | {
"name": "copy_to_next",
"type": "bool",
"optional": true,
"description": "If true, any changes to session attributes will be also applied to the 'next attributes' list."
} { "name": "refid", "type": "int", "optional": true, "description": "RefId of player to change. Used only when player attributes are included. Note that you need to run multiple calls to modify multiple players" } { "name": "participantid", "type": "int", "optional": true, "description": "Id of participant to change. Used only when participant attributes are included. Note that you need to run multiple calls to modify multiple players" } { "name": "session_NAME", "type": "string", "optional": true, "description": "Session attribute to set. See /api/list/attributes/session for the list of all valid attribute names and types. Only writable attributes can be set" } { "name": "player_NAME", "type": "string", "optional": true, "description": "Player attribute to set. Remember to also set 'refid'. See /api/list/attributes/player for the list of all valid attribute names and types. Only writable attributes can be set" } { "name": "participant_NAME", "type": "string", "optional": true, "description": "Participant attribute to set. Remember to also set 'participantid'. See /api/list/attributes/participant for the list of all valid attribute names and types. Only writable attributes can be set" } |
| api/session/set_next_attributes | Update session attributes to be applied to next new session or next lobby when current session loads back into the lobby | admin | json | {
"name": "session_NAME",
"type": "string",
"optional": true,
"description": "Session attribute to set. See /api/list/attributes/session for the list of all valid attribute names and types. Only writable attributes can be set"
} |
| api/session/send_chat | Send chat message to the game | admin | json | {
"name": "message",
"type": "string",
"optional": false,
"description": "The message to send"
} { "name": "refid", "type": "int", "optional": true, "description": "RefId of the recipient of the message. If not set the message will be sent to all" } |
| api/session/status | Return basic session status | private | json | {
"name": "attributes",
"type": "bool",
"optional": true,
"description": "Include session/player/participant attributes in the response?"
} { "name": "members", "type": "bool", "optional": true, "description": "Include session members (players) in the response?" } { "name": "participants", "type": "bool", "optional": true, "description": "Include session participants (cars) in the response?" } |