PacificES Cloud API

API Endpoint

https://api.pacifices.cloud

This API enables developers to integrate their services and products into our infrastructure to automate the creation and management of cloud servers. We have designed the API to follow the RESTful guidelines, which allows you to send HTTP requests to interact with the API.

Authentication

Authentication with the API is done through the use of an Authorization header that is sent with the request. The Authorization header paired with an API key that can be retrieved from within your Account will successfully authenticate and allow you to interact with the API. The API key is a randomly generated string of 64 characters in length.

Example

Below is an example of a request that uses the Authorization header. Note the API key after the header.

GET /v1/servers
    HOST: api.pacifices.cloud
    Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO
    Content-Type: application/json

Exceptions

When using the API, global application exceptions may occur. These are:

Code	Description
`1000`	API key provided is not valid
`1001`	The requested resource does not exist
`1002`	An application error occurred, please try again
`1003`	Payload is not valid JSON
`1004`	Authorization header not present

Servers ¶

GET https://api.pacifices.cloud/v1/servers?status=running&name=Example Server&cost=180&created=1486385953&charge_period=daily&game_mode=1&game_type=0&hourly_rate=95&last_running=1486385953&maximum_rate=2000&started=1486385955&tickrate=128&version=1.35.6.6

Requestsexample 1

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": [
    {
      "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "name": "Example Server",
      "map": {
        "group": "mg_active",
        "id": "de_cache",
        "name": "de_cache",
        "type": "default"
      },
      "cost": 95,
      "created": 1486386447,
      "node": {
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "ip": "1.2.3.4",
        "location": {
          "city": "Sydney",
          "code": "au",
          "country": "Australia"
        },
        "version": {
          "expiry": 1486386932,
          "retrieved": 1486386032,
          "version": "1.35.6.6"
        }
      },
      "admins": [],
      "charge_period": "daily",
      "first_config": "",
      "game_mode": 1,
      "game_type": 0,
      "git_url": "",
      "zip_url": "",
      "hourly_rate": 95,
      "last_running": null,
      "maximum_rate": null,
      "mods": [],
      "owner": "76561198000000000",
      "password": true,
      "password_value": "INGJJMFA2IILAIZOM8FL",
      "plugins": [
        "warmod"
      ],
      "rcon": "JS0ED38RZWVXM8VTYTZ1",
      "started": 1486386451,
      "status": "running",
      "tickrate": "128",
      "version": "1.35.6.6",
      "network": {
        "ports": {
          "client": 37295,
          "game": 33706,
          "gotv": 40970,
          "rcon": 42837,
          "steam": 39776
        }
      },
      "disable_default_mods": true,
      "disable_default_plugins": true,
      "eac": {
        "enabled": true,
        "league_id": "XXXX",
        "api_key": "XXXXXXXXXXXXXXXXXXX"
      },
      "auto_destroy": 5,
      "branding": "PacificES Cloud"
    }
  ]
}

List all servers
GET`/v1/servers{?status,name,cost,created,charge_period,game_mode,game_type,hourly_rate,last_running,maximum_rate,started,tickrate,version}`

Lists all servers in your account. By default returns all servers regardless of their status. Use the ?status=running to only get the running servers.

URI Parameters

HideShow

status: string (optional) Example: running
Status of a server.
name: string (optional) Example: Example Server
Name of a server.
cost: number (optional) Example: 180
Current cost of the server.
created: number (optional) Example: 1486385953
When the server was created.
charge_period: string (optional) Example: daily
How often the server is being charged.
game_mode: number (optional) Example: 1
Game mode of a server.
game_type: number (optional) Example: 0
Game type of a server.
hourly_rate: number (optional) Example: 95
The rate at which the server is charged at.
last_running: number (optional) Example: 1486385953
When the server was last running.
maximum_rate: number (optional) Example: 2000
The maximum rate for the server.
started: number (optional) Example: 1486385955
When the server was started.
tickrate: string (optional) Example: 128
The server tickrate.
version: string (optional) Example: 1.35.6.6
The server version.

POST https://api.pacifices.cloud/v1/servers

Requestsexample 1

Headers

Content-Type: application/json
Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Body

{
  "name": "Server Name",
  "first_config": null,
  "gamemode": "competitive",
  "map": {
    "type": "default",
    "id": "de_cache",
    "group": "mg_active"
  },
  "mods": [],
  "vac": true,
  "password": {
    "enabled": true,
    "value": "server_password"
  },
  "plugins": [
    "warmod"
  ],
  "rcon": "rcon_password",
  "tickrate": "128",
  "location": {
    "city": "Sydney"
  },
  "game_token": null,
  "git_url": null,
  "zip_url": null,
  "disable_default_mods": false,
  "disable_default_plugins": true,
  "eac": {
    "enabled": true,
    "league_id": "XXXX",
    "api_key": "XXXXXXXXXXXXXXXXXXX"
  },
  "auto_destroy": 5,
  "branding": "Example Branding"
}

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": {
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
  }
}

Create a new server
POST`/v1/servers`

Create a new server. This also starts the server after successfully creating the server. If there is an error validating the server payload that you have provided, the API will return an array of errors.

We have two options for the cloning of a Git repo and the downloading of a zip file. These options allow you to include configuration files and mods that we do not normally provide. To use these, set the git or zip URL to the desired URL and the server will clone/download it when it starts. One requirement when using these options is that you must specify your own Steam game token. This prevents you misusing the game tokens we provide.

disable_default_mods allows you to disable the default mods that come with the server. These mods are: csay, metamod and sourcemod. This setting is perfect for people looking for a stock csgo server.

disable_default_plugins allows you to disable the default plugins that come with Sourcemod. This setting is perfect for people wanting Sourcemod, but doesn’t want all the extras that come with it. It works independently of disable_default_mods, to provide finer grain customisation.

The EAC field allows you to specify EasyAntiCheat details for the server. To simply disable EAC for the server, just set enabled to false. You must provide your API key and League ID for EAC to function properly.

auto_destroy allows you to specify an integer in minutes for the server to automatically destroy itself if the server has not had any players in it for the auto_destroy time. Do not include this value if you want to disable the functionality.

branding allows you to specify the branding to use for the server. This will appear in the CS:GO “hostname” field, as well as in the server list. Set the option to an empty string to completely disable branding. Remove the field completely to use the default branding.

Note: EAC requires the RCON password TO NOT contain anything other than letters or numbers. If the RCON password contains anything but these, it will not function properly.

Note: “first_config” can either be null or blank to specify no first config. To specify a first config, use the file’s ID (obtained through the control panel or the API).

vac allows you to start a server with Valve Anti Cheat (VAC) on or off. Turning VAC off be desirable for certain configurations which collide with VAC turned on. For any servers without such specific requirements, VAC is recommended to always be on. vac is set to true by default.

Server Payload Validation ¶

POST https://api.pacifices.cloud/v1/servers/validate

Requestsexample 1example 2

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Body

{
  "name": "Server Name",
  "first_config": null,
  "gamemode": "competitive",
  "map": {
    "type": "default",
    "id": "de_cache",
    "group": "mg_active"
  },
  "mods": [],
  "vac": true,
  "password": {
    "enabled": true,
    "value": "server_password"
  },
  "plugins": [
    "warmod"
  ],
  "rcon": "rcon_password",
  "tickrate": "128",
  "location": {
    "city": "Sydney"
  },
  "game_token": "XXXXXXX",
  "git_url": null,
  "zip_url": "https://example.com/example.zip",
  "disable_default_mods": true,
  "disable_default_plugins": false,
  "eac": {
    "enabled": false
  }
}

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": {
    "errors": [],
    "valid": true
  }
}

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Body

{
  "name": "Server Name",
  "first_config": null,
  "gamemode": "competitive",
  "map": {
    "type": "default",
    "id": "de_cache",
    "group": "mg_active"
  },
  "mods": [],
  "password": {
    "enabled": true,
    "value": "server_password"
  },
  "plugins": [
    "warmod"
  ],
  "rcon": "",
  "tickrate": "128",
  "location": {
    "city": "Sydney"
  },
  "game_token": "XXXXXXX",
  "git_url": null,
  "zip_url": "https://example.com/example.zip",
  "disable_default_mods": true,
  "disable_default_plugins": false,
  "eac": {
    "enabled": true,
    "league_id": "XXXX",
    "api_key": "XXXXXXXXXXXXXXXXXXX"
  },
  "auto_destroy": 5,
  "branding": "Example"
}

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": {
    "errors": [
      "RCON is not valid, it does not follow the correct format"
    ],
    "valid": false
  }
}

Validate a create server payload
POST`/v1/servers/validate`

Validate a payload used to create a server.

PUT https://api.pacifices.cloud/v1/servers/validate

Requestsexample 1example 2

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Body

{
    "rcon": "new_rcon",
}

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": {
    "errors": [],
    "valid": true
  }
}

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Body

{
  "rcon": ""
}

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": {
    "errors": [
      "RCON is not valid, it does not follow the correct format"
    ],
    "valid": false
  }
}

Validate a server settings payload
PUT`/v1/servers/validate`

Validate a payload used to update a server’s settings.

Server Actions ¶

GET https://api.pacifices.cloud/v1/servers/id

Requestsexample 1

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": {
    "server": {
      "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "name": "Example Server",
      "map": {
        "group": "mg_active",
        "id": "de_cache",
        "name": "de_cache",
        "type": "default"
      },
      "cost": 95,
      "created": 1486386447,
      "node": {
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "ip": "1.2.3.4",
        "location": {
          "city": "Sydney",
          "code": "au",
          "country": "Australia"
        },
        "version": {
          "expiry": 1486386932,
          "retrieved": 1486386032,
          "version": "1.35.6.6"
        }
      },
      "admins": [],
      "charge_period": "daily",
      "first_config": "",
      "game_mode": 1,
      "game_type": 0,
      "git_url": "",
      "zip_url": "",
      "hourly_rate": 95,
      "last_running": null,
      "maximum_rate": null,
      "mods": [],
      "owner": "76561198000000000",
      "password": true,
      "password_value": "INGJJMFA2IILAIZOM8FL",
      "plugins": [
        "warmod"
      ],
      "rcon": "JS0ED38RZWVXM8VTYTZ1",
      "started": 1486386451,
      "status": "running",
      "tickrate": "128",
      "version": "1.35.6.6",
      "network": {
        "ports": {
          "client": 37295,
          "game": 33706,
          "gotv": 40970,
          "rcon": 42837,
          "steam": 39776
        }
      },
      "disable_default_mods": true,
      "disable_default_plugins": true,
      "eac": {
        "enabled": true,
        "league_id": "XXXX",
        "api_key": "XXXXXXXXXXXXXXXXXXX"
      },
      "auto_destroy": null,
      "branding": "PacificES Cloud"
    }
  }
}

Get a server
GET`/v1/servers/{id}`

Retrieve a server’s information.

URI Parameters

HideShow

id: string (required)
Id of a server.

DELETE https://api.pacifices.cloud/v1/servers/id

Requestsexample 1

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": null
}

Destroy a server
DELETE`/v1/servers/{id}`

Destroy a server.

URI Parameters

HideShow

id: string (required)
Id of a server.

PUT https://api.pacifices.cloud/v1/servers/id

Requestsexample 1

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Body

{
  "gamemode": "deathmatch",
  "map": {
    "type": "default",
    "id": "de_dust2",
    "group": "mg_active"
  }
}

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": null
}

Change a server's settings
PUT`/v1/servers/{id}`

Change a server’s settings. Also performs an update on the server to ensure the server settings are applied.

This endpoint uses the same payload that is used to create a server, but only requires that you send the values that you actually want to change on the server.

The example below sets the map and changes the gamemode of the server.

See server payload validation for the validation endpoints that are used to validate a create server or change server setting payloads.

URI Parameters

HideShow

id: string (required)
Id of a server.

Server Logs ¶

GET https://api.pacifices.cloud/v1/servers/id/logs?format=json

Requestsexample 1

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": {
    "logs": [
      {
        "log": "------------------ Configuring PacificES Cloud Server ------------------\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:50.811045869Z"
      },
      {
        "log": "Updating the panel with the server version...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:50.815616412Z"
      },
      {
        "log": "Downloading latest Metamod, this may take some time...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:50.825055261Z"
      },
      {
        "log": "Decompressing Metamod, this may take some time...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:51.7167479Z"
      },
      {
        "log": "Downloading latest Sourcemod, this may take some time...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:51.757377202Z"
      },
      {
        "log": "Decompressing Sourcemod, this may take some time...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:52.507565063Z"
      },
      {
        "log": "Downloading latest csay, this may take some time...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:52.753198171Z"
      },
      {
        "log": "Decompressing csay, this may take some time...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.412945429Z"
      },
      {
        "log": "Setting sv_password to RGI9LJVUHXLGPH83WA6J...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.465926548Z"
      },
      {
        "log": "Setting rcon_password to YSWSDE13NIV7N28W92DP...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.465934893Z"
      },
      {
        "log": "Adding your steamid to Sourcemod admins...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.467226255Z"
      },
      {
        "log": "Adding your configs to the /home/csgo/server/csgo/cfg/ folder...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.538944482Z"
      },
      {
        "log": "Setting hostname...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.540493742Z"
      },
      {
        "log": "Setting up GOTV...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.541700793Z"
      },
      {
        "log": "Setting some performance variables...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.542992562Z"
      },
      {
        "log": "Configuring warmod plugin...\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.580900388Z"
      },
      {
        "log": "-------------------- Starting PacificES Cloud Server -------------------\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.588745301Z"
      },
      {
        "log": "ip = XXX.XXX.XXX.XXX\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.588767542Z"
      },
      {
        "log": "name = Test Server\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.588771488Z"
      },
      {
        "log": "server_id = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.588774133Z"
      },
      {
        "log": "owner = STEAM_0:1:XXXXXXXXX\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.588781925Z"
      },
      {
        "log": "game_type = 0\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.588789475Z"
      },
      {
        "log": "game_mode = 1\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.5888868Z"
      },
      {
        "log": "mapgroup = mg_active\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.588891996Z"
      },
      {
        "log": "map = de_cache\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.588894615Z"
      },
      {
        "log": "tickrate = 128\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.588906315Z"
      },
      {
        "log": "game_port = 45972\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.588909049Z"
      },
      {
        "log": "gotv_port = 35124\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.588967231Z"
      },
      {
        "log": "--------------------------------------------------------------------------\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.588972154Z"
      },
      {
        "log": "Server will auto-restart if there is a crash.\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.600162753Z"
      },
      {
        "log": "LD_LIBRARY_PATH=/home/csgo/server/bin:/home/csgo/server:/home/csgo/server/bin:\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:53.617958826Z"
      },
      {
        "log": "#\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:55.749507169Z"
      },
      {
        "log": "#Console initialized.\r\n",
        "stream": "stdout",
        "time": "2017-03-27T00:38:55.749520286Z"
      }
    ]
  }
}

Get server logs
GET`/v1/servers/{id}/logs{?format}`

Retrieve a server’s logs.

The format of the logs can be specified. ?format=json returns the logs in JSON format as the example. ?format=raw returns the logs in a basic, unstructured log format that you might find from a server console.

By default, JSON is used to format the response if no format is specified.

URI Parameters

HideShow

id: string (required)
Id of a server.
format: string (optional) Example: json
Format to return the logs in. Options: json, raw

Server Player History ¶

GET https://api.pacifices.cloud/v1/servers/id/player-history

Requestsexample 1

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": [
    {
      "players": 10,
      "time": 1487674802
    },
    {
      "players": 10,
      "time": 1487675702
    },
    {
      "players": 10,
      "time": 1487676602
    },
    {
      "players": 0,
      "time": 1487677502
    },
    {
      "players": 0,
      "time": 1487678401
    }
  ]
}

Get server player history
GET`/v1/servers/{id}/player-history`

Get a history of the player count on the server.

URI Parameters

HideShow

id: string (required)
Id of a server.

Server Player Count ¶

GET https://api.pacifices.cloud/v1/servers/id/player-count

Requestsexample 1

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": {
    "players": 10
  }
}

Get server player count
GET`/v1/servers/{id}/player-count`

Get the current count of players in the server

URI Parameters

HideShow

id: string (required)
Id of a server.

Server Version ¶

GET https://api.pacifices.cloud/v1/servers/id/version

Requestsexample 1example 2

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Responses200

Headers

Content-Type: application/json

Body

{
  "server_version": "1.35.6.6",
  "node_version": "1.35.6.6",
  "server_out_of_date": false
}

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Responses200

Headers

Content-Type: application/json

Body

{
  "server_version": "1.35.6.5",
  "node_version": "1.35.6.6",
  "server_out_of_date": true
}

Get server version
GET`/v1/servers/{id}/version`

Get the current server version and whether the server is up-to-date.

URI Parameters

HideShow

id: string (required)
Id of a server.

Server Command ¶

POST https://api.pacifices.cloud/v1/servers/id/command

Requestsexample 1

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Body

{
    "command": "map de_dust2",
}

Responses200

Headers

Content-Type: application/json

Body

{
    "success": true,
    "error": false,
    "result: null
}

Send server command
POST`/v1/servers/{id}/command`

Send a command to a server.

URI Parameters

HideShow

id: string (required)
Id of a server.

Server Restart ¶

POST https://api.pacifices.cloud/v1/servers/id/restart

Requestsexample 1

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Responses200

Headers

Content-Type: application/json

Body

{
    "success": true,
    "error": false,
    "result: null
}

Restart a server
POST`/v1/servers/{id}/restart`

Restart a server.

URI Parameters

HideShow

id: string (required)
Id of a server.

Server Update ¶

POST https://api.pacifices.cloud/v1/servers/id/update

Requestsexample 1

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Responses200

Headers

Content-Type: application/json

Body

{
    "success": true,
    "error": false,
    "result: null
}

Update a server
POST`/v1/servers/{id}/update`

Update a server.

URI Parameters

HideShow

id: string (required)
Id of a server.

Server History ¶

GET https://api.pacifices.cloud/v1/servers/id/history

Requestsexample 1

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": [
    {
      "metadata": [],
      "time": 1487674297,
      "type": "create",
      "user": "76561198000000000"
    },
    {
      "metadata": [],
      "time": 1487674299,
      "type": "start",
      "user": "76561198000000000"
    },
    {
      "metadata": {
        "version": "1.35.6.8"
      },
      "time": 1487674299,
      "type": "set-version",
      "user": "system"
    }
  ]
}

Get server history
GET`/v1/servers/{id}/history`

Retrieve a server’s history.

URI Parameters

HideShow

id: string (required)
Id of a server.

Locations ¶

GET https://api.pacifices.cloud/v1/locations

Requestsexample 1

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": [
    {
      "city": "Melbourne",
      "code": "au",
      "country": "Australia"
    },
    {
      "city": "Perth",
      "code": "au",
      "country": "Australia"
    },
    {
      "city": "Sydney",
      "code": "au",
      "country": "Australia"
    }
  ]
}

Get available locations
GET`/v1/locations`

Get all available locations where you can deploy a server.

Mapgroups ¶

GET https://api.pacifices.cloud/v1/mapgroups

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": {
    "mg_active": {
      "name": "Active Duty Pool",
      "key": "mg_active",
      "maps": {
        "de_cache": {
          "name": "Cache",
          "key": "de_cache"
        },
        "de_cbble": {
          "name": "Cobblestone",
          "key": "de_cbble"
        },
        "de_dust2": {
          "name": "Dust 2",
          "key": "de_dust2"
        },
        "de_inferno": {
          "name": "Inferno",
          "key": "de_inferno"
        },
        "de_mirage": {
          "name": "Mirage",
          "key": "de_mirage"
        },
        "de_overpass": {
          "name": "Overpass",
          "key": "de_overpass"
        },
        "de_train": {
          "name": "Train",
          "key": "de_train"
        },
        "de_nuke": {
          "name": "Nuke",
          "key": "de_nuke"
        }
      }
    }
  }
}

Get available mapgroups
GET`/v1/mapgroups`

Get all available mapgroups.

Mods ¶

GET https://api.pacifices.cloud/v1/mods

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": [
    "retakes",
    "pugsetup",
    "multi-1v1"
  ]
}

Get available mods
GET`/v1/mods`

Get all available mods.

Plugins ¶

GET https://api.pacifices.cloud/v1/plugins

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": [
    "warmod",
    "nadetails",
    "infuse_competitive",
    "infuse_deathmatch",
    "infuse_survival",
  ]
}

Get available plugins
GET`/v1/plugins`

Get all available plugins.

Tickrates ¶

GET https://api.pacifices.cloud/v1/tickrates

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": [
    64,
    128
  ]
}

Get available tickrates
GET`/v1/tickrates`

Get all available tickrates.

Gamemodes ¶

GET https://api.pacifices.cloud/v1/gamemodes

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": [
    "competitive",
    "casual",
    "armsrace",
    "demolition",
    "deathmatch"
  ]
}

Get available gamemodes
GET`/v1/gamemodes`

Get all available gamemodes.

Files ¶

GET https://api.pacifices.cloud/v1/files

Requestsexample 1

Headers

Authorization: nhqPAgr1Y1kD6Fu1GJEwsFIJAgV44Q3YQekXDrFHEM2Kw1CTz4pgFy7xz26fFJKO

Responses200

Headers

Content-Type: application/json

Body

{
  "success": true,
  "error": false,
  "result": [
    {
      "name": "_2017-03-26-xxxx-xxxx-xxxxx.log",
      "md5": "83558638e2c72548203af18cbe1d72b6",
      "size": 4096,
      "last_modified": 1490568494,
      "link": "https://cloudstrike.s3.amazonaws.com/demos/76561198000000000/_2017-03-26-xxxx-xxxx-xxxxx.log"
    },
    {
      "name": "_2017-03-26-xxxx-xxxx-xxxxx.dem",
      "md5": "ec6213cd2f991c7b99cdd0122e68126d",
      "size": 625086,
      "last_modified": 1490568494,
      "link": "https://cloudstrike.s3.amazonaws.com/demos/76561198000000000/_2017-03-26-xxxx-xxxx-xxxxx.dem"
    },
    {
      "name": "_2017-03-26-xxxx-xxxx-xxxxx.dem",
      "md5": "e93412b0cb5871187c45ed1ed6a06062",
      "size": 1028462,
      "last_modified": 1490568469,
      "link": "https://cloudstrike.s3.amazonaws.com/demos/76561198000000000/_2017-03-26-xxxx-xxxx-xxxxx.dem"
    },
    {
      "name": "_2017-03-xxxx-xxxx-xxxxx.log",
      "md5": "552f7437fa0e28739a4eaf86525ca2a3",
      "size": 668,
      "last_modified": 1490568469,
      "link": "https://cloudstrike.s3.amazonaws.com/demos/76561198000000000/_2017-03-26-xxxx-xxxx-xxxxx.log"
    },
    {
      "name": "2017-03-26-xxxx-xxxx-xxxxx.dem",
      "md5": "61c92589529a72bf9e33d804cf8ffcf4",
      "size": 2480835,
      "last_modified": 1490522196,
      "link": "https://cloudstrike.s3.amazonaws.com/demos/76561198000000000/2017-03-26-xxxx-xxxx-xxxxx.dem"
    },
    {
      "name": "_2017-03-26-xxxx-xxxx-xxxxx.log",
      "md5": "2afe5cebf5de1fbfc6a9f13653644a2f",
      "size": 14245,
      "last_modified": 1490522179,
      "link": "https://cloudstrike.s3.amazonaws.com/demos/76561198000000000/_2017-03-26-xxxx-xxxx-xxxxx.log"
    },
    {
      "name": "_2017-03-26-xxxx-xxxx-xxxxx.dem",
      "md5": "8ee514e8cbb23510d0845fd8937b9fc1",
      "size": 1214339,
      "last_modified": 1490521894,
      "link": "https://cloudstrike.s3.amazonaws.com/demos/76561198000000000/_2017-03-26-xxxx-xxxx-xxxxx.dem"
    },
    {
      "name": "_2017-03-26-xxxx-xxxx-xxxxx.log",
      "md5": "1ac81f511c2462cc8a3fba2ad6f57f9c",
      "size": 542,
      "last_modified": 1490521894,
      "link": "https://cloudstrike.s3.amazonaws.com/demos/76561198000000000/_2017-03-26-xxxx-xxxx-xxxxx.log"
    }
  ]
}

Get available files
GET`/v1/files`

Get all available files.

Generated by aglio on 09 Mar 2023

API Endpoint

Authentication ¶

Example ¶

Exceptions ¶

Global Application Exceptions ¶

Servers ¶

Servers ¶

Headers

Headers

Body

List all serversGET/v1/servers{?status,name,cost,created,charge_period,game_mode,game_type,hourly_rate,last_running,maximum_rate,started,tickrate,version}

Headers

Body

Headers

Body

Create a new serverPOST/v1/servers

Server Payload Validation ¶

Headers

Body

Headers

Body

Headers

Body

Headers

Body

Validate a create server payloadPOST/v1/servers/validate

Headers

Body

Headers

Body

Headers

Body

Headers

Body

Validate a server settings payloadPUT/v1/servers/validate

Server Actions ¶

Headers

Headers

Body

Get a serverGET/v1/servers/{id}

Headers

Headers

Body

Destroy a serverDELETE/v1/servers/{id}

Headers

Body

Headers

Body

Change a server's settingsPUT/v1/servers/{id}

Server Logs ¶

Headers

Headers

Body

Get server logsGET/v1/servers/{id}/logs{?format}

Server Player History ¶

Headers

Headers

Body

Get server player historyGET/v1/servers/{id}/player-history

Server Player Count ¶

Headers

Headers

Body

Get server player countGET/v1/servers/{id}/player-count

Server Version ¶

Headers

Headers

Body

Headers

Headers

Body

Get server versionGET/v1/servers/{id}/version

Server Command ¶

Headers

Body

Headers

Body

Send server commandPOST/v1/servers/{id}/command

Server Restart ¶

Headers

Authentication

Example

Exceptions

Global Application Exceptions

List all servers
GET`/v1/servers{?status,name,cost,created,charge_period,game_mode,game_type,hourly_rate,last_running,maximum_rate,started,tickrate,version}`

Create a new server
POST`/v1/servers`

Validate a create server payload
POST`/v1/servers/validate`

Validate a server settings payload
PUT`/v1/servers/validate`

Get a server
GET`/v1/servers/{id}`

Destroy a server
DELETE`/v1/servers/{id}`

Change a server's settings
PUT`/v1/servers/{id}`

Get server logs
GET`/v1/servers/{id}/logs{?format}`

Get server player history
GET`/v1/servers/{id}/player-history`

Get server player count
GET`/v1/servers/{id}/player-count`

Get server version
GET`/v1/servers/{id}/version`

Send server command
POST`/v1/servers/{id}/command`

Restart a server
POST`/v1/servers/{id}/restart`

Update a server
POST`/v1/servers/{id}/update`

Get server history
GET`/v1/servers/{id}/history`

Get available locations
GET`/v1/locations`

Get available mapgroups
GET`/v1/mapgroups`

Get available mods
GET`/v1/mods`

Get available plugins
GET`/v1/plugins`

Get available tickrates
GET`/v1/tickrates`

Get available gamemodes
GET`/v1/gamemodes`

Get available files
GET`/v1/files`