Guardian Onlybans API Documentation
The primary purpose of this API is to allow for Communities that don't use or don't have access to Battlemetrics to build their own integration into GuardianOnlybans.
This Documentation is a Work in Progress and is subject to changes. GuardianOnlybans is under no obligation to prioritize the updating of this API.
If your question is not addressed, pleae visit our Discord.
Table of Contents
Authorization
Authorization is required for Guardian Endpoints that require an API Token. To obtain an API Token you must:
1. Have the Sq License Owner Role in the OWI Hosting Discord and apply to #guard-my-community in the Guardian Discord. Upon approval, you will be given an API Token for use to send Ban Data to GuardianOnlybans.
/boloCheck
GET /boloCheck
Check if a SteamID is in the Guardian BOLO List.
Query Parameters:
- steamID - String - The SteamID to check.
Response:
- status - String - Query status.
- message - String - The message returned by the query.
- data - String - Returned Data
/ping
GET /ping
Returns a simple response to check if the API is online.