The Web Service API allows your dedicated server to receive and respond to remote HTTP calls. This allows server admins to do things such as post live in-game messages to display to all players, or query stats on the current game.

*The API will expand it's functionality as the game continues to develop.

To allow your server to receive http calls, you must enable the web service in UDKWeb.ini (within /UDKGame/Config/). Note: The server must run at least once to generate the various UDK*.ini config files.

Set bEnabled to true and set a username and password (these can be whatever you choose and the password does not need to match the password you are using for your admin login when joining the server in-game).

Now when running your server like normal, you will see in the log that the web service has been enabled, which will list your service ip:port that you will use to connect:

In this example I am using Postman[www.postman.com] to test calls against the API, but you can use any command-line/scripting tools (such as curl, etc).

Set request headers for username and password to match what you have set for AdminWebUsername and AdminWebPassword in your UDKWeb.ini config.

We can now test the web service is running by making a call to it's status endpoint (all endpoints are prefixed with http://<ip:port>/admin):
If the service is reachable you should see a response like the following:

If you get a timeout on the request, check that the ListenPort you have set in your UDKWeb.ini is correctly forwarded on your server machine to accept incoming http requests (see reference for port forwarding[www.noip.com]).

Posts an in-game message to all players for a set duration. Displays in the top-left the player's display. HTTP request type: POST.


Example:

Will display in-game as follows: