© copyright 2022-2025 connexvpn. All rights reserved.

(modified) Designed with love by Xiaoying Riley for developers

installing a game

using the api

you can install a game by running the following command

request

curl \
	-X POST \
	-H "CX-API-Token: {my-generated-token}" \
	-H "Accept: application/json" \
	-H "Content-Type: application/json" \
	https://api.connexvpn.com/games/{game}

response

status and messages

http code status message
200 installed the game was successfully installed
201 installed the game is currently in the process of installing
400 Bad Request the request could not be understood or was missing required parameters
401 Unauthorized invalid token provided
404 Not Found the game was not found
426 Upgrade Required the system needs to be updated or not enough resources available
500 Internal Server Error something went wrong, please contact your administrator

instructions

a series of instructions will be provided once the game is successfully installed.

example
{
	"id": 1,
	"name": "Minecraft",
	"version": "1.20.1",
	"status": "installed",
	"instructions": "https://connexvpn.com/docs/games/instructions/minecraft/",
}