Husqy API logging module

General

Endpoints related to general Husqy Modules Logging.

GET - /modules/logging/

Home endpoint for the Modules Logging Husqy API. Returns only success message displaying that it is the Modules Logging Husqy API route.

GET - /modules/logging/settings

Return the settings for the logging module of a specified guild.

Query string parameters:

field	required	type	description
guild_id	yes	integer	The ID of the guild to get the settings from

Possible errors:

• BadRequestError
• SettingsError
• ModuleDisabledError

PUT - /modules/logging/settings

Edit the settings for the logging module of a specified guild.

Body data (JSON):

field	required	type	description
guild_id	yes	integer	The ID of the guild to get the settings from
events	yes	dict	A dictionary of the settings to change with their new value

Possible errors:

• BadRequestError
• SettingsError
• ModuleDisabledError

DELETE - /modules/logging/settings/delete

Delete all settings of the logging module for a specified guild.

Body data (JSON):

field	required	type	description
guild_id	yes	integer	The ID of the guild to delete the settings from

Possible errors:

• BadRequestError

Status

Endpoints related to the status of the module

GET - /modules/logging/status

Get the status of the logging module for the specified guild.

Query string parameters:

field	required	type	description
guild_id	yes	integer	The ID of the guild to check the status of

Possible errors:

• BadRequestError
• SettingsError

POST - /modules/logging/enable

Endpoint to enable the logging module for the specified guild.

Body data (JSON):

field	required	type	description
guild_id	yes	integer	The ID of the guild to enable the logging module for
logs_channel_id	yes	integer	The ID of the channel to use as the logs channel

Possible errors:

• BadRequestError
• SettingsError
• ModuleEnabledError
• DatabaseError

POST - /modules/logging/disable

Endpoint to disable the logging module for the specified guild.

Body data (JSON):

field	required	type	description
guild_id	yes	integer	The ID of the guild to disable the logging module for

Possible errors:

• BadRequestError
• SettingsError
• ModuleDisabledError
• DatabaseError

Log

Endpoints related to sending the log message

POST - /modules/logging/event/check

danger

Do not use this endpoint yourself! Log messages will be send by Husqy automatically.

Endpoint to check the event for sending a log message to the guild.

Body data (JSON):

field	required	type	description
guild_id	yes	integer	The ID of the guild where the event has taken place
event_info	yes	dict	The info of the event to sent the log message for

Possible errors:

• BadRequestError
• SettingsError
• ModuleDisabledError

Privacy

Endpoints related to privacy and the tags module

GET - /modules/logging/privacy/get-user-entries

danger

Do not use this endpoint yourself! This endpoint will be used by Husqy's Privacy configurator (/privacy) command.

Endpoint to get the amount of references in logging to your user.

Query string parameters:

field	required	type	description
guild_id	yes	integer	The ID of the guild to get the specified references in
privacy_member_id	yes	integer	The ID of the member who wants to check their references

Possible errors:

• BadRequestError
• ForbiddenError
• InternalServerError

DELETE - /modules/logging/privacy/delete-user-entries

danger

Do not use this endpoint yourself! This endpoint will be used by Husqy's Privacy configurator (/privacy) command.

Endpoint to delete the references in logging to your user.

Body data (JSON):

field	required	type	description
guild_id	yes	integer	The ID of the guild to delete the specified references in
privacy_member_id	yes	integer	The ID of the member who wants to remove their references

Possible errors:

• BadRequestError
• ForbiddenError
• InternalServerError