Logging settings

Get logging options

Changed on

Returns the server-wide logging options.

get/servers/{guild_id}/config/logging/settings

Request

Path parameters

guild_idstring required
Example:301655085954367490

The server's ID. Must be the server the token was created for.

Query parameters

bot'pro'

Set to pro to act on the Quark Pro bot's configuration. Leave out for the main Quark bot.

Response

One row.

idstring

The server ID.

spoilers0 | 1

1 if re-posted files are marked as spoilers.

format_type0 | 1 | 2 | 3

Log format. 0 is Standard, 1 is Compact, 2 is Standard (no embed), 3 is Compact (no embed). A format the server built and has in use is not shown here.

ignore_bot_targets0 | 1

1 if actions done to bots are not logged.

ignore_bot_executors0 | 1

1 if actions done by bots are not logged.

active_ignore0 | 1

1 if Active Ignore is on for every log type. See the Active Ignore endpoints.

buttonsinteger

Bitfield of the standard buttons shown on logs. 1 is User ID, 2 is Support Server, 4 is Customise.

pluralkit_integration0 | 1

1 if PluralKit compatibility is on.

pro_promotions0 | 1

1 if logs may include a note when part of a log needs Quark Pro.

modlog_lock_afterinteger nullable

How long a modlog's reason can be edited, in seconds after the modlog was posted. null means always editable. 0 means never editable.

log_namestring nullable

The name logs are posted under. null for Quark's name. Only used on Quark Pro or Pro Lite.

log_avatar0 | 1 | null nullable

1 when the avatar is the server's icon, otherwise 0 or null. See log_avatar_ref for the avatar itself.

log_avatar_refstring nullable

The avatar logs are posted under, as log_avatar takes it on PATCH: "quark", "icon", "emoji:<id>", "role:<id>" or "preset:<name>". null when it was never set, in which case log_avatar says. Only used on Quark Pro or Pro Lite.

Example response

[
  {
    "id": "301655085954367490"
  }
]

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • warning

      added the new 1.00 enum value to the / response property for the response status

    • warning

      added the new 3.00 enum value to the / response property for the response status