API key
Read the API Overview to get started and learn more.
Create API key
⚠️
This route is not accessible via api keys.
Generate an API key. Currently only available to the guild owner. You can also view your current token in the App.
POST
/
apikeys
Request body
| Field | Type | Description |
|---|---|---|
| guild_id | string | The guild ID for which the key is valid |
Response body
| Field | Type | Description |
|---|---|---|
| key | string | New api key |
| user_id | string | The owner of the generated key |
| guild_id | string | Guild where the key is valid |
Returns a 200 status
Update key
⚠️
This route is not available to api users.
Generate a new API key by providing the current one. Currently only available to the guild owner.
PUT
/
apikeys
/
key
Parameters
- keyThe API key that should be replaced by a new one
Request body
-
Response body
| Field | Type | Description |
|---|---|---|
| key | string | New api key |
| user_id | string | The owner of the generated key |
| guild_id | string | Guild where the key is valid |
Returns a 200 status
Delete key
⚠️
This route is not available to api users.
Delete the provided API key.
DELETE
/
apikeys
/
key
Parameters
- keyThe API key that should be deleted
Request body
-
Response body
-
Returns a 204 status
