Open Cloud API Introduction
The Sentinel Open Cloud API allows developers to interact with Sentinel’s moderation tools programmatically. By leveraging the API, you can integrate moderation actions like banning and unbanning players directly into your custom systems or workflows. This guide introduces the basics of using the Sentinel Open Cloud API.
Base URL
The base URL for all API requests is:
Replace {version} with the specific API version you are targeting, such as v1.
Authentication
Certain endpoints, such as those used for banning or unbanning players, require authentication via a Bearer token. This token is tied to an API Key associated with your Workspace.
Example Authentication Header:
Make sure to include this header in your requests when interacting with protected endpoints.
Managing API Keys
Each Workspace in Sentinel has an associated API Key that is used to perform sensitive actions like banning or unbanning players.
To create a new API key, run the following command in your Discord server:
This will generate a new API key for your Workspace and automatically invalidate the old one. Always keep your API key secure, as it grants access to critical moderation functionality.
Key Use Cases
The Open Cloud API can be used for several moderation actions, including:
Banning a Player: Enforce bans across your games and services programmatically.
Unbanning a Player: Lift bans on players directly through API calls.
Checking if a player is banned
Security Best Practices
Keep API Keys Secure: Do not share your API keys publicly. Treat them like passwords, as they grant access to your Workspace’s secure tools.
Use HTTPS: Ensure that all API requests are made over HTTPS to protect your data and authentication information.
With the Sentinel Open Cloud API, you have full control over integrating and automating your community's moderation system. Whether you want to build custom dashboards, automate banning workflows, or sync actions across services, Sentinel’s API provides the tools you need.
Last updated