GamingAPI

Rust public API 0.9.0

test

Servers

148.251.43.103:4222natsproduction
GamingAPI NATS production broker

Operations

PUB v0/rust/servers/{server_id}/events/started
Channel for the API to process for when a server has started

You can consume this event to learn when the server was started

Operation IDServerStarted
server_id
required
string
uid: server_id
The ID of the server
Accepts the following message:
ServerStarted
object
uid: ServerStarted
timestamp
required
string
Additional properties are allowed.
Examples
{ "timestamp": "2016-08-29T09:12:33.001Z" }

This example has been generated automatically.
PUB v0/rust/servers/{server_id}/events/stopped
Channel for the API to process for when a server has stopped

You can consume this event to learn when the server was stopped

Operation IDServerStopped
server_id
required
string
uid: server_id
The ID of the server
Accepts the following message:
ServerStopped
object
uid: ServerStopped
timestamp
required
string
Additional properties are allowed.
Examples
{ "timestamp": "2016-08-29T09:12:33.001Z" }

This example has been generated automatically.
PUB v0/rust/servers/{server_id}/events/player/{steam_id}/chatted
Event for when a player used the chat

You can consume this event to learn when a player used the in-game chat

Operation IDPlayerChatted
server_id
required
string
uid: server_id
The ID of the server

steam_id
required
string
uid: steam_id
The steam ID of a player
Accepts the following message:
PlayerChatted
object
uid: ChatMessage
steam_id
required
string
must match: ^[0-9]{17}$
The player's steamID64, must be 17 chars long.

player_name
required
string
raw_message
string
The raw message before being converted with title and rank

full_message
required
string
is_admin
required
boolean
rank
integer
title
string
timestamp
required
string
Additional properties are allowed.
Examples
{ "steam_id": "string", "player_name": "string", "raw_message": "string", "full_message": "string", "is_admin": true, "rank": 0, "title": "string", "timestamp": "2016-08-29T09:12:33.001Z" }

This example has been generated automatically.
PUB v0/rust/servers/{server_id}/events/wiped
Channel for the API to process when a server has just wiped

Operation IDServerWiped
server_id
required
string
uid: server_id
The ID of the server

Accepts the following message:
ServerWiped
Payload
null
Examples
This example has been generated automatically.
PUB v0/rust/servers/{server_id}/players/{steam_id}/events/connected
Channel for the API to process for when a player connects to a server

Operation IDServerPlayerConnected
server_id
required
string
uid: server_id
The ID of the server

steam_id
required
string
uid: steam_id
The steam ID of a player
Accepts the following message:
ServerPlayerConnected
object
uid: ServerPlayerConnected
connected_timestamp
required
string
required
object
uid: Player
id
required
string
name
required
string
address
required
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "connected_timestamp": "2016-08-29T09:12:33.001Z", "player": { "id": "string", "name": "string", "address": "string" } }

This example has been generated automatically.
PUB v0/rust/servers/{server_id}/players/{steam_id}/events/disconnected
Channel for the API to process for when a player disconnects from a server

Operation IDServerPlayerDisconnected
server_id
required
string
uid: server_id
The ID of the server

steam_id
required
string
uid: steam_id
The steam ID of a player
Accepts the following message:
ServerPlayerDisconnected
object
uid: ServerPlayerDisconnected
disconnected_timestamp
required
string
required
object
uid: ServerPlayerDisconnectedPlayer
id
required
string
Additional properties are allowed.
reason
string
Additional properties are allowed.
Examples
{ "disconnected_timestamp": "2016-08-29T09:12:33.001Z", "player": { "id": "string" }, "reason": "string" }

This example has been generated automatically.
PUB v0/rust/servers/{server_id}/players/{steam_id}/events/gatheredResources
Channel for the API to process for when a player gathers some resources

Operation IDServerPlayerResourceGathered
server_id
required
string
uid: server_id
The ID of the server

steam_id
required
string
uid: steam_id
The steam ID of a player
Accepts the following message:
ServerPlayerResourceGathered
object
uid: ServerPlayerResourceGathered
gathered_timestamp
required
string
steam_id
required
string
must match: ^[0-9]{17}$
The player's steamID64, must be 17 chars long.

item_uid
required
integer
item_id
required
integer
amount
required
integer
required
object
uid: ActiveItem
uid
integer
item_id
integer
Additional properties are allowed.
object
uid: PlayerPosition
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "gathered_timestamp": "2016-08-29T09:12:33.001Z", "steam_id": "string", "item_uid": 0, "item_id": 0, "amount": 0, "gathering_item": { "uid": 0, "item_id": 0 }, "gathering_position": { "x": 0, "y": 0, "z": 0 } }

This example has been generated automatically.
PUB v0/rust/servers/{server_id}/players/{steam_id}/events/respawned
Channel for the API to process for when a player respawn

Operation IDServerPlayerRespawned
server_id
required
string
uid: server_id
The ID of the server

steam_id
required
string
uid: steam_id
The steam ID of a player
Accepts the following message:
ServerPlayerRespawned
object
uid: ServerPlayerRespawned
steam_id
required
string
must match: ^[0-9]{17}$
The player's steamID64, must be 17 chars long.

respawn_timestamp
required
string
required
object
uid: PlayerPosition
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "steam_id": "string", "respawn_timestamp": "2016-08-29T09:12:33.001Z", "respawn_position": { "x": 0, "y": 0, "z": 0 } }

This example has been generated automatically.
PUB v0/rust/servers/{server_id}/players/{steam_id}/events/combat/hit
Channel for the API to process for when a player hits another player

Operation IDServerPlayerCombatPlayerhit
server_id
required
string
uid: server_id
The ID of the server

steam_id
required
string
uid: steam_id
The steam ID of a player
Accepts the following message:
ServerPlayerCombatPlayerhit
object
uid: ServerPlayerCombatPlayerhit
hit_timestamp
required
string
required
object
uid: PlayerOnPlayerHit
hit_area_id
required
integer
hit_distance
required
number
hit_damage
required
number
isKill
required
boolean
required
object
uid: PlayerHit
steam_id
required
string
must match: ^[0-9]{17}$
The player's steamID64, must be 17 chars long.

required
object
uid: PlayerPosition
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: ActiveItem
uid
integer
item_id
integer
Additional properties are allowed.
Additional properties are allowed.
required
object
uid: PlayerHit
steam_id
required
string
must match: ^[0-9]{17}$
The player's steamID64, must be 17 chars long.

required
object
uid: PlayerPosition
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: ActiveItem
uid
integer
item_id
integer
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "hit_timestamp": "2016-08-29T09:12:33.001Z", "player_hit": { "hit_area_id": 0, "hit_distance": 0, "hit_damage": 0, "isKill": true, "victim": { "steam_id": "string", "position": { "x": 0, "y": 0, "z": 0 }, "active_item": { "uid": 0, "item_id": 0 } }, "attacker": { "steam_id": "string", "position": { "x": 0, "y": 0, "z": 0 }, "active_item": { "uid": 0, "item_id": 0 } } } }

This example has been generated automatically.
PUB v0/rust/servers/{server_id}/players/{steam_id}/events/items/{item_id}/pickup
Channel for the API to process for when a player pickup items ingame

Operation IDServerPlayerItemPickup
server_id
required
string
uid: server_id
The ID of the server

steam_id
required
string
uid: steam_id
The steam ID of a player

item_id
required
string
uid: item_id
The ID of an item
Accepts the following message:
ServerPlayerItemPickup
object
uid: ServerPlayerItemPickup
pickup_timestamp
required
string
steam_id
required
string
must match: ^[0-9]{17}$
The player's steamID64, must be 17 chars long.

item_uid
required
integer
item_id
required
integer
amount
integer
Additional properties are allowed.
Examples
{ "pickup_timestamp": "2016-08-29T09:12:33.001Z", "steam_id": "string", "item_uid": 0, "item_id": 0, "amount": 0 }

This example has been generated automatically.
PUB v0/rust/servers/{server_id}/players/{steam_id}/events/items/{item_id}/loot
Channel for the API to process for when a player loots an item ingame

Operation IDServerPlayerItemLoot
server_id
required
string
uid: server_id
The ID of the server

steam_id
required
string
uid: steam_id
The steam ID of a player

item_id
required
string
uid: item_id
The ID of an item
Accepts the following message:
ServerPlayerItemLoot
object
uid: ServerPlayerItemLoot
loot_timestamp
required
string
steam_id
required
string
must match: ^[0-9]{17}$
The player's steamID64, must be 17 chars long.

item_uid
required
integer
item_id
required
integer
container_uid
required
integer
container_prefab
required
string
object
uid: PlayerPosition
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
amount
required
integer
Additional properties are allowed.
Examples
{ "loot_timestamp": "2016-08-29T09:12:33.001Z", "steam_id": "string", "item_uid": 0, "item_id": 0, "container_uid": 0, "container_prefab": "string", "container_position": { "x": 0, "y": 0, "z": 0 }, "amount": 0 }

This example has been generated automatically.
PUB v0/rust/servers/{server_id}/players/{steam_id}/events/items/{item_id}/crafted
Channel for the API to process for when a player crafts items ingame

Operation IDServerPlayerItemCrafted
server_id
required
string
uid: server_id
The ID of the server

steam_id
required
string
uid: steam_id
The steam ID of a player

item_id
required
string
uid: item_id
The ID of an item
Accepts the following message:
ServerPlayerItemCrafted
object
uid: ServerPlayerItemCrafted
craft_timestamp
required
string
steam_id
required
string
must match: ^[0-9]{17}$
The player's steamID64, must be 17 chars long.

item_uid
required
integer
item_id
required
integer
amount
required
integer
Additional properties are allowed.
Examples
{ "craft_timestamp": "2016-08-29T09:12:33.001Z", "steam_id": "string", "item_uid": 0, "item_id": 0, "amount": 0 }

This example has been generated automatically.
PUB v0/rust/servers/{server_id}/events/command
Channel for the API to process for when a server command is run

Operation IDServerCommand
server_id
required
string
uid: server_id
The ID of the server
Accepts the following message:
ServerCommand
object
uid: ServerCommand
command
string
arguments
string
steam_id
string
must match: ^[0-9]{17}$
The player's steamID64 which are running the command, must be 17 chars long.

timestamp
required
string
Additional properties are allowed.
Examples
{ "command": "string", "arguments": "string", "steam_id": "string", "timestamp": "2016-08-29T09:12:33.001Z" }

This example has been generated automatically.
PUB v0/rust/servers/{server_id}/players/{steam_id}/events/reported
Channel for the API to process for when a player is reported

Operation IDServerPlayerReported
server_id
required
string
uid: server_id
The ID of the server

steam_id
required
string
uid: steam_id
The steam ID of a player
Accepts the following message:
ServerPlayerReported
object
uid: ServerPlayerReported
reporter_steam_id
required
string
must match: ^[0-9]{17}$
The player's steamID64 which reported the player, must be 17 chars long.

reported_target_steam_id
required
string
must match: ^[0-9]{17}$
The player's steamID64 which are reported, must be 17 chars long.

subject
string
message
string
reportedType
string
timestamp
required
string
Additional properties are allowed.
Examples
{ "reporter_steam_id": "string", "reported_target_steam_id": "string", "subject": "string", "message": "string", "reportedType": "string", "timestamp": "2016-08-29T09:12:33.001Z" }

This example has been generated automatically.
PUB v0/rust/servers/{server_id}/players/{steam_id}/events/unbanned
Channel for notifying a server unbanned a player

Operation IDServerPlayerUnbanned
server_id
required
string
uid: server_id
The ID of the server

steam_id
required
string
uid: steam_id
The steam ID of a player
Accepts the following message:
ServerPlayerUnbanned
object
uid: ServerPlayerUnbanned
steam_id
required
string
must match: ^[0-9]{17}$
The player's steamID64 which are unbanned, must be 17 chars long.

name
string
timestamp
required
string
Additional properties are allowed.
Examples
{ "steam_id": "string", "name": "string", "timestamp": "2016-08-29T09:12:33.001Z" }

This example has been generated automatically.
PUB v0/rust/servers/{server_id}/players/{steam_id}/events/banned
Channel for notifying a server banned a player

Operation IDServerPlayerBanned
server_id
required
string
uid: server_id
The ID of the server

steam_id
required
string
uid: steam_id
The steam ID of a player
Accepts the following message:
ServerPlayerBanned
object
uid: ServerPlayerBanned
player_name
required
string
steam_id
required
string
must match: ^[0-9]{17}$
The player's steamID64, must be 17 chars long.

reason
string
duration
string
timestamp
required
string
Additional properties are allowed.
Examples
{ "player_name": "string", "steam_id": "string", "reason": "string", "duration": "string", "timestamp": "2016-08-29T09:12:33.001Z" }

This example has been generated automatically.

Servers

Operations

PUB v0/rust/servers/{server_id}/events/started

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/events/stopped

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/events/player/{steam_id}/chatted

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/events/wiped

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/players/{steam_id}/events/connected

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/players/{steam_id}/events/disconnected

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/players/{steam_id}/events/gatheredResources

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/players/{steam_id}/events/respawned

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/players/{steam_id}/events/combat/hit

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/players/{steam_id}/events/items/{item_id}/pickup

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/players/{steam_id}/events/items/{item_id}/loot

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/players/{steam_id}/events/items/{item_id}/crafted

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/events/command

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/players/{steam_id}/events/reported

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/players/{steam_id}/events/unbanned

Examples

This example has been generated automatically.

PUB v0/rust/servers/{server_id}/players/{steam_id}/events/banned

Examples

This example has been generated automatically.