Managing API Keys

API keys are managed on a per Discord server basis. When you add FiveRoster to your Discord server you'll have the option to generate API keys for your specific use within that server.

The data requested through the API will only be for the corresponding server and the rosters created within. If you attempt to retrieve roster information with an API key that isn't tied to the rosters Discord server then you will receive an error.

Generating a new API key

To create a new API key, you'll need to head to the server page in FiveRoster and click on the "Settings" tab. From here, you'll see a section titled "API Key Management". Then, click on the "Create API Key" button in the top right to be shown a modal to provide a name for your key and also set an optional expiry.

Your API key is to be kept secret as anyone with it can pull information from your rosters including player information and ranks.