infiSTAR Vision API documentation

Authorization

You can obtain your API keys in the 'Client' Tab in your server dashboard found here: Go to your server dashboard.

This API is a RESTful API with industry standard HTTP requests and JSON responses.

Requests

In order to use our API you need to provide a server ident vi-server-ident and the matching server secret key vi-server-secret as HTTP-Headers in your request.

Required Parameters

Name	Type	Format	Description
API Ident	String	vi-server-ident	Public server identication key.
API Secret	String	vi-server-secret	Private server identication key.

The request body data needs to be in a JSON encoded data array as shown down below.

Responses

All requests returns a JSON formatted response. The requested data is stored in a DATA tag. In order to check if the request was successful we include a boolean STATUS tag outside the DATA tag. For debugging purposes you can use the MESSAGE tag.

HTTP status codes

HTTP status codes give you information whether your request was successful or not.

Code	Status	Description
200	OK	Your request was successful
400	Bad Request	Your request was invalid.
401	Unauthorized	Your request has no permission.
403	Forbidden	Your request is not authorized.
429	Request Overflow	See Rate Limit for more information.

Rate Limit

Our API is using rate limiting to prevent request spam. Every server ident can request 50 requests per minute and 5 requests per second.

Player Management

Send player regarding commands to your server via rcon.

POST Kick Player Available games: ArmA 3, ARK: Survival Evolved

Starter

Pro

Ultra

Kicks a player from your gameserver.

POST https://api.infistar.vision/v1/server/player/kick

Name	Type	Format	Description
Player UID / GUID Required	String(17/32)	uid	Steam64 ID or BE GUID of the selected player.
Kick Reason Required	String	reason	Kick reason for the selected player. Will be shown to the player.

POST Ban Player Available games: ArmA 3, ARK: Survival Evolved

Starter

Pro

Ultra

Bans a player from your gameserver. Note: Bans will be added to a queue, if your server is offline.

POST https://api.infistar.vision/v1/server/player/ban

Name	Type	Format	Description
Player UID / GUID Optional	String(17/32)	uid	Steam64 ID or BE GUID of the selected player.
Player IP Optional	String	ip	Ban a player IP address. Note: ArmA 3 only.
Ban Reason Required	String	reason	Ban reason for the selected player. Will be shown to the player.
Ban Duration Required	Int	duration	Ban duration in minutes. Permanent if 0.

GET Get Player List Available games: ArmA 3, ARK: Survival Evolved

Starter

Pro

Ultra

Get a list of all players currently on your server.

GET https://api.infistar.vision/v1/server/player/players

GET Get Player Bans Available games: ArmA 3

Starter

Pro

Ultra

Get all player bans in an array.

GET https://api.infistar.vision/v1/server/player/bans

POST Unban Player Available games: ArmA 3, ARK: Survival Evolved

Starter

Pro

Ultra

Unban a player from your gameserver.

POST https://api.infistar.vision/v1/server/player/unban

Name	Type	Format	Description
Player UID / GUID Optional	String(17/32)	uid	Steam64 ID or BE GUID of the selected player.
Ban ID Optional	String	id	BattlEye ban id. Not player UID / GUID!

POST Private Message Player Available games: ArmA 3, ARK: Survival Evolved

Starter

Pro

Ultra

Send a private message to a specific player in-game.

POST https://api.infistar.vision/v1/server/player/message

Name	Type	Format	Description
Player UID / GUID Required	String(17/32)	uid	Steam64 ID or BE GUID of the selected player.
Message Required	String	message	Private message send to player.

Cloudban Management

Interact with the infiSTAR Cloudban database.

GET Get infiSTAR ban information of a Steam UID.Available games: All

Starter

Pro

Ultra

Get player ban state.

GET https://api.infistar.vision/v1/cloudban/:steamid/baninfo

Name	Type	Format	Description
Steam64 UID Required	String	:steamid	Steam UID of the banned user.