Web API

Web API

RESTful API for accessing exported ARK Server save data via HTTP in JSON- or XML-format.

A SignalR hub push server update notifications to connected clients in real-time.

How to change the default web API port?

The prebuilt web-app included in release builds is by default configured to call the web API on 127.0.0.1:60001. If you want to use another port for the web API you will need to make this change in environment.prod.ts and rebuild the web-app dist manually using:

ng build --prod --bh /

Endpoints

The setting webApiListenPrefix configures the base path for the web API.

Endpoint	Description
/api/map/mapName	ARK topographic maps for sourced from ARK Survival Evolved Wiki (http://ark.gamepedia.com). Maps: TheIsland, TheCenter, ScorchedEarth_P and Ragnarok
/api/player/steamId	Player data for player identified by steamId from each configured server instance.
/api/server/serverKey	Player and tribe listing from each configured server instance.
/api/wildcreatures/serverKey	Wild creatures and wild creature statistics.
/api/adminserver/serverKey	Player and tribe listing with additional creature and structure counts from each configured server instance.
/api/structures/serverKey	Clustered structure data used to show the location of tribes/structures in the ARK. With ARK-Server-Beyond-API and ImprovedCommands administrators may remotely destroy and clean-up old structures and tamed creatures in the ARK.
/api/servers	User-, access control- and server status information including active players and statistics for each configured server instance.
/api/administer/...	Rcon and other commands exposed through the web app.
/api/authentication/...	Authenticate players using Steam
/signalr/ (hub name ServerUpdateHub)	Server update notifications using SignalR.