Windrose Server RESTAPI (UE4SS)

Description

This is a RESTAPI for your Windrose dedicated server and provides a few basic endpoints.

Keep in mind that this RESTAPI is still in development and requires UE4SS to be installed on your dedicated server.

Endpoints

List of available endpoints.

• []/info - Displays extensive information on your server.[/]

  []/players - Shows list of players[/]

  []/kick - Kicks a player by Account ID.[/]

  []/ban - Bans a player by Account ID. Bans stored in mod folder.[/]

  []/banlist - Shows currently banned players with information on when and why they were banned.[/]

Installation instructions

• []You will need to install UE4SS for Windrose.[/]

  []Extract the WindroseAPI folder to the  R5\Binaries\Win64\ue4ss\Mods directory.[/]

  []Configure the settings.ini in the mod folder with your port and API key.[/]

  []Restart the server.[/]

Requirements

This mod requires UE4SS for Windrose.

Example Use w/ Powershell

Player List Example:

Invoke-RestMethod -Uri "http://localhost:9600/players" -Method GET -Headers @{Authorization="Bearer changeme"}Kick Player Example:

Invoke-RestMethod -Uri "http://localhost:9600/kick" -Method POST -Headers @{Authorization="Bearer changeme"; "Content-Type"="application/json"} -Body '{"account_id":"1A1A326042CF5D2936F38444C108719A"}'Ban Player Example:

Invoke-RestMethod -Uri "http://localhost:9600/ban" -Method POST -Headers @{Authorization="Bearer changeme"; "Content-Type"="application/json"} -Body '{"account_id":"1A1A326042CF5D2936F38444C108719A","reason":"Cheating"}'Unban Player Example:

Invoke-RestMethod -Uri "http://localhost:9600/unban" -Method POST -Headers @{Authorization="Bearer changeme"; "Content-Type"="application/json"} -Body '{"account_id":"1A1A326042CF5D2936F38444C108719A"}'Banlist Example:

Invoke-RestMethod -Uri "http://localhost:9600/banlist" -Method GET -Headers @{Authorization="Bearer changeme"}Server Info Example:

Invoke-RestMethod -Uri "http://localhost:9600/info" -Method GET -Headers @{Authorization="Bearer changeme"}