Skip to main content
GET
Get logging options

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

guild_id
string
required

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

Pattern: ^\d{17,20}$
Example:

"301655085954367490"

Query Parameters

bot
enum<string>

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

Available options:
pro

Response

One row.

id
string

The server ID.

Pattern: ^\d{17,20}$
Example:

"301655085954367490"

spoilers
enum<integer>

1 if re-posted files are marked as spoilers.

Available options:
0,
1
format_type
enum<integer>

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.

Available options:
0,
1,
2,
3
ignore_bot_targets
enum<integer>

1 if actions done to bots are not logged.

Available options:
0,
1
ignore_bot_executors
enum<integer>

1 if actions done by bots are not logged.

Available options:
0,
1
active_ignore
enum<integer>

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

Available options:
0,
1
buttons
integer

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

pluralkit_integration
enum<integer>

1 if PluralKit compatibility is on.

Available options:
0,
1
pro_promotions
enum<integer>

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

Available options:
0,
1
modlog_lock_after
integer | null

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

Required range: 0 <= x <= 31536000
log_name
string | null

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

log_avatar
enum<integer> | null

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

Available options:
0,
1,
null
log_avatar_ref
string | null

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

log_profile_overrides

Each log channel's own name and avatar, keyed by channel ID. May be returned as JSON text.