Admin instance

Instance configuration is everything an operator can change at runtime. It covers single sign-on, Gateway rollout, registration policy, branding and legal links, instance policy, third party integrations, media retention, and the ordered limit configuration. The Instance resource serves the subset published to unauthenticated clients.

Every write is a merge over the stored configuration, and an omitted key leaves the stored value unchanged. The limit configuration write is the one exception and replaces the stored document.

Reading configuration requires the Admin ACL instance:config:view, and writing it requires instance:config:update. The limit configuration has its own pair, instance:limit_config:view and instance:limit_config:update.

That relaxation applies only to a session credential, so an Admin API key and a bearer token are evaluated normally even before setup is complete. Completing setup grants the acting session the wildcard ACL. Registration URLs, pending registrations, and limit configuration always need their own ACL.

Instance configuration object

The complete runtime configuration of the deployment. Every configuration operation here except the limit configuration returns it.

Missing settings use the defaults documented below. Invalid stored configuration causes an error rather than silently resetting a policy. Operators can find recovery guidance under stored instance policy.

Structure

Field	Type	Description
sso	SSO configuration object	Single sign-on settings
gateway_rollout	Gateway rollout configuration object	Gateway admission and dispatch tuning
voice_noise_suppression	voice noise suppression configuration object	Client-side noise suppression rollout
push_service_delivery	push service delivery configuration object	Push service delivery rollout
domain_migration	domain migration configuration object	Web domain migration rollout
experiment_delivery	experiment delivery configuration object	Cadence every client polls the experiments route on
registration	registration configuration object	Registration policy, issued URLs, and pending registrations
self_hosted	boolean	Whether the deployment runs in self-hosted mode
app_public	public application configuration object	Branding, legal, setup, and registration field policy
policy	instance policy object	Community, direct message, premium, and gating policy
integrations	instance integrations object	Third party provider settings and their resolved availability
media	instance media object	Attachment retention settings

SSO configuration object

Single sign-on settings for the deployment’s OpenID Connect provider.

Structure

Field	Type	Description
enabled	boolean	Whether single sign-on is offered
enforced¹	boolean	Whether single sign-on is the only accepted login method
display_name	?string	Provider name shown on the login screen
issuer	?string	OpenID Connect issuer
authorization_url	?string	Authorisation endpoint
token_url	?string	Token endpoint
userinfo_url	?string	Userinfo endpoint
jwks_url	?string	JWKS endpoint
client_id	?string	Registered client identifier
client_secret_set	boolean	Whether a client secret is stored
scope	?string	Space-separated scope string
allowed_domains²	array[string]	Email domains permitted to sign in (max 100 entries)
auto_provision	boolean	Whether a first-time sign-in creates an account
redirect_uri³	?string	Redirect URI to register with the provider

¹ A deployment that has never stored the value reports the same value as enabled

² Each entry is stored lowercased and IDNA encoded, duplicates are collapsed, and an empty entry is dropped

³ The configured web application endpoint followed by /auth/sso/callback. No operation can set it

Gateway rollout configuration object

Admission and dispatch tuning for the Gateway cluster.

Structure

Field	Type	Description
session_rollout_percentage	number	Percentage of sessions admitted to the new Gateway (0-100, default 100)
session_rollout_mode	string	`modulo` or `random` (default `modulo`)
guild_rollout_percentage	number	Percentage of guilds admitted to the new Gateway (0-100, default 100)
rpc_request_timeout_ms	integer	Deadline for one Gateway RPC (1000-60000, default 10000)
max_concurrent_session_starts	integer	Session starts admitted at once (1-10000, default 512)
max_concurrent_guild_starts	integer	Guild starts admitted at once (1-10000, default 256)
gateway_dispatch_relay_shards	integer	Dispatch relay shard count (1-10000, default 32)
gateway_dispatch_relay_max_queue	integer	Dispatch relay queue ceiling (0-1000000, default 50000)
voice_e2ee_scope	string	`guild_feature_only` or `platform_wide` (default `guild_feature_only`)

Every field is present on read. An absent document or missing field uses the defaults above.

Admin reads and writes name this field rpc_request_timeout_ms. The legacy stored name is covered in the operator configuration reference.

Voice noise suppression configuration object

The instance rollout of client-side noise suppression. Experiments defines what a client resolves from it and the closed backend registry every backend field draws on.

Structure

Field	Type	Description
enabled	boolean	Whether the rollout runs at all (default false)
config_version	integer	Revision counter, raised by FiveCord and never accepted from a request
default_backend	string	Backend given to an account the rollout selects (default `standard`)
enabled_backends	array[string]	Backends a client MAY run, up to 7 entries (default every backend)
allow_user_override	boolean	Whether an account’s own choice replaces the assigned backend (default true)
rollout_basis_points	integer	Share of accounts the rollout selects, in basis points (0-10000, default 0)
rollout_salt	string	Salt of the sampling hash (1-64 characters, default `voice-ns-v1`)
included_user_ids	array[snowflake]	Accounts the rollout always selects, up to 1000 entries (default empty)
excluded_user_ids	array[snowflake]	Accounts the rollout never selects, up to 1000 entries (default empty)
guild_overrides	array[guild override object]	Per-guild replacements, up to 200 entries (default empty)
suppression_strength	integer	Suppression strength (0-100, default 80)

Every field is present on read. An absent document or missing field uses the defaults above.

excluded_user_ids is applied before included_user_ids, so the rollout never selects an account in both. A default_backend or guild_overrides entry naming a backend outside enabled_backends is dropped from what a client is served, and the stored value is kept as written.

How often a client revalidates this rollout is not set here. It is set once for every experiment in the experiment delivery configuration below.

Push service delivery configuration object

The instance rollout of push service delivery.

Structure

Field	Type	Description
enabled	boolean	Whether the rollout runs at all (default false)
config_version	integer	Revision counter, raised by FiveCord and never accepted from a request
rollout_basis_points	integer	Share of accounts the rollout selects, in basis points (0-10000, default 0)
rollout_salt	string	Salt of the sampling hash (1-64 printable ASCII characters, default `push-service-delivery-v1`)
included_user_ids	array[snowflake]	Accounts the rollout always selects, up to 1000 entries (default empty)
excluded_user_ids	array[snowflake]	Accounts the rollout never selects, up to 1000 entries (default empty)

Every field is present on read. An absent document or missing field uses the defaults above.

Domain migration configuration object

The instance rollout that moves the official web client from its legacy origin to a new one. Experiments defines what a signed-in client resolves from it. The instance discovery document publishes enabled, anonymous_rollout_basis_points, rollout_salt, and standalone_forwarding for clients that are not signed in.

Structure

Field	Type	Description
enabled	boolean	Whether the rollout runs at all (default false)
config_version	integer	Revision counter, raised by FiveCord and never accepted from a request
rollout_basis_points	integer	Share of accounts the rollout selects, in basis points (0-10000, default 0)
rollout_salt	string	Salt of the sampling hash (1-64 printable ASCII characters, default `domain-migration-v1`)
included_user_ids	array[snowflake]	Accounts the rollout always selects, up to 1000 entries (default empty)
excluded_user_ids	array[snowflake]	Accounts the rollout never selects, up to 1000 entries (default empty)
anonymous_rollout_basis_points	integer	Share of logged-out devices the rollout moves, in basis points (0-10000, default 0)
standalone_forwarding	boolean	Whether installed desktop web apps forward to the new origin once their data has moved (default false)

Every field is present on read. An absent document or missing field uses the defaults above.

excluded_user_ids is applied before included_user_ids, so the rollout never selects an account in both.

An installed Chromium desktop web app moves its data like a browser tab, then stays on the legacy origin and offers to install the app from the new one. Set standalone_forwarding once the web app manifest lists the new origin in scope_extensions and the new origin serves the matching association file. From then on the installed app forwards like a browser tab. Installed mobile and Safari web apps never forward, whatever the value.

Only the official web client acts on this configuration. On any other instance it changes nothing a client does.

Experiment delivery configuration object

How often a client polls Get experiment assignments, and how widely those polls are spread. The setting is instance-wide and applies to every experiment at once, so adding an experiment adds no second cadence to tune.

Structure

Field	Type	Description
poll_interval_seconds	integer	Seconds between client revalidations (60-86400, default 300)
poll_jitter_percent	integer	Maximum random change to each revalidation interval, as a percentage in either direction (0-50, default 15)

Every field is present on read. An absent document or missing field uses the defaults above.

Both fields are served to every account, whether or not any experiment targets that account, and neither one is versioned by config_version. A client that has never received a response from the experiments route uses built-in defaults of 300 seconds and 15 percent, which equal the defaults above. A client that cannot read the route never receives either field.

Registration configuration object

Registration policy in force, plus every issued registration URL and every account awaiting a decision.

Structure

Field	Type	Description
mode	string	Registration mode
admin_registration_urls_enabled¹	boolean	Whether Admin-issued registration URLs are accepted
urls²	array[registration URL object]	Every issued registration URL, including revoked and exhausted records
pending_registrations³	array[pending registration object]	Accounts awaiting a decision

¹ While the value is false, registration refuses every supplied registration URL code, so an issued URL stops working without being revoked

² Ordered by creation time, newest first

³ Ordered by request time, oldest first

Both collections are embedded in the configuration response. There is no separate listing operation and no pagination, so every configuration read returns every issued URL.

Registration modes

Value	Description
open	Anyone can register
approval	Anyone can register, and an Admin decision is required before the account can be used
closed	Public registration is closed

A valid registration URL is accepted in every mode, including closed, and its own approval_required replaces the mode for the account it creates.

Registration URL object

A registration URL is an invitation an Admin can issue while the registration mode is closed or approval. It has its own expiry, use budget, and approval requirement.

FiveCord accepts a URL while it has no revocation time, has not passed its expiry, and has a use count below max_uses. A URL failing any of those tests is still reported here.

Structure

Field	Type	Description
id¹	string	Identifier of the registration URL (1-128 characters)
label	?string	Admin note attached to the URL, or null when unset
created_by_user_id	snowflake	Admin account that issued the URL
created_at	ISO8601 timestamp	Time the URL was issued
expires_at	?ISO8601 timestamp	Time the URL stops working, or null when it never expires
max_uses	?integer	Maximum permitted uses, or null for unlimited use
use_count	integer	How many registrations have completed through the URL
revoked_at	?ISO8601 timestamp	Time the URL was revoked, or null while it has not been revoked
approval_required²	boolean	Whether an account created through the URL still needs an Admin decision
last_used_at	?ISO8601 timestamp	Time the URL was last used, or null when it never has been
last_used_by_user_id	?snowflake	Most recent account created through the URL, or null when there is none

¹ A randomly generated UUID that is also the bearer code authorising registration, so every reader of the configuration can redeem an unrevoked URL

² The value replaces the instance registration mode for an account created through this URL, in both directions. A URL with the value false lets an account skip approval on an instance in approval mode

Example

{
  "id": "3f2a91c4-6d1e-4a77-9f0b-2c5d8e114a20",
  "label": "Design team",
  "created_by_user_id": "1478812292088791040",
  "created_at": "2026-08-20T10:00:00.000Z",
  "expires_at": null,
  "max_uses": 25,
  "use_count": 3,
  "revoked_at": null,
  "approval_required": false,
  "last_used_at": "2026-08-29T18:22:10.000Z",
  "last_used_by_user_id": "1500901337221828608"
}

Pending registration object

One account that registered and is still waiting for an Admin decision.

Structure

Field	Type	Description
user_id	snowflake	Account awaiting a decision
username	string	Username chosen at registration
discriminator	integer	Discriminator tag from 0 to 9999
global_name	?string	Display name of the account, or null when unset
email	?string	Email address of the account, or null when none is stored
requested_at	ISO8601 timestamp	Time the account registered
registration_url_id	?string	Registration URL the account signed up through (1-128 characters), or null when it registered directly
client_ip¹	?string	IP address the account registered from, or null when none was recorded

¹ Stored at registration time and never refreshed, so it can be stale by the time an Admin reads it

Public application configuration object

Branding, legal, setup and registration field policy, in the Admin form of what the Instance resource publishes to clients.

Structure

Field	Type	Description
branding	public branding object	Product name, image URLs, and theme colour
setup¹	object	Has the single boolean `configured`
legal	public legal configuration object	Terms and privacy URLs
registration²	public registration fields object	Registration field collection policy

¹ The Instance resource publishes admin_url in this object as well

² The object has the single boolean collect_date_of_birth

Instance policy object

Community, direct message, premium and gating policy for the whole deployment.

Structure

Field	Type	Description
single_community_enabled	boolean	Whether the deployment presents one community
single_community_guild_id	?string	Guild used as that community, or null before one has been created
direct_messages_disabled	boolean	Whether direct messages are disabled
direct_messages_locked¹	boolean	Whether the direct message setting is locked against further change
premium_mode	string	Premium mode
services	object	Operator overrides for `gif_enabled`, `youtube_enabled`, and `bluesky_enabled`. Each is nullable, and null means no override
services_resolved²	object	The same keys as concrete booleans, resolved from the override and the provider’s own availability
services_available³	object	Provider availability for `gif`, `youtube`, and `bluesky`, with no operator override applied
deferred_phone_gate	deferred phone gate object	Delayed phone verification policy

¹ The lock is set each time direct messages are re-enabled. Update instance configuration clears it when the policy object has direct_messages_locked set to false

² Each key is the operator override when one is set, and otherwise the matching services_available value

³ gif and youtube report whether an API key resolves from the stored configuration or the deployment configuration. bluesky is the value of integrations.bluesky.effective_enabled

Premium modes

Value	Description
mirror	Resolve premium access from the account’s own entitlement and premium flags
everyone	Grant premium access to every account on a self-hosted deployment

Deferred phone gate object

A rule for accounts whose phone verification requirement was deferred. When such an account joins a guild within window_hours of registration, and the guild has the DISCOVERABLE feature or more than member_threshold members, FiveCord refuses the join until the account verifies a phone.

Structure

Field	Type	Description
enabled	boolean	Whether the delayed phone requirement is applied (default false)
window_hours	number	Hours after registration in which the requirement can be applied (default 6)
member_threshold	number	Guild member count above which the requirement is applied (default 50)

Instance integrations object

Every provider reports its stored settings, a _set boolean in place of each secret, and the availability resolved from the stored settings and the deployment configuration.

Structure

Field	Type	Description
gif	object	`klipy_api_key_set` and `effective_available`
youtube	object	`api_key_set` and `effective_available`
captcha	captcha integration object	CAPTCHA provider settings
email	email integration object	Outbound email settings
bluesky	Bluesky integration object	Bluesky client settings

Captcha integration object

CAPTCHA provider settings, and the provider resolved from them.

Structure

Field	Type	Description
provider	?string	Operator override of `hcaptcha`, `turnstile`, or `none`, or null for no override
effective_provider	string	Provider in use, one of `hcaptcha`, `turnstile`, or `none`
hcaptcha_site_key	?string	hCaptcha site key
hcaptcha_secret_key_set	boolean	Whether an hCaptcha secret is stored or supplied by deployment configuration
turnstile_site_key	?string	Turnstile site key
turnstile_secret_key_set	boolean	Whether a Turnstile secret is stored or supplied by deployment configuration
effective_enabled	boolean	Whether CAPTCHA verification is in force

Email integration object

Outbound email settings, and the provider resolved from them.

Structure

Field	Type	Description
enabled	?boolean	Operator override, or null for no override
effective_enabled	boolean	Whether outbound email is in force
provider	?string	Operator override of `smtp` or `none`, or null for no override
effective_provider	string	Provider in use, either `smtp` or `none`
from_email	?string	Envelope sender address
from_name	?string	Envelope sender name
smtp¹	object	`host`, `port`, `username`, `secure`, and `password_set`
disable_new_ip_authorization	boolean	Whether new-IP authorisation email is suppressed by the stored setting
effective_disable_new_ip_authorization²	boolean	Whether it is suppressed once outbound email state is taken into account

¹ host, username, and secure are nullable, port is a nullable integer from 1 to 65535, and password_set is a plain boolean

² True whenever the stored setting is true or outbound email is not in force

Bluesky integration object

Client identity the deployment presents to Bluesky, and the number of signing keys in its effective configuration.

Structure

Field	Type	Description
enabled	?boolean	Operator override, or null for no override
effective_enabled	boolean	Whether the integration is enabled with at least one configured signing key
client_name	?string	Client name presented to Bluesky
client_uri	?string	Client URI
logo_uri	?string	Client logo URI
tos_uri	?string	Client terms URI
policy_uri	?string	Client policy URI
key_count	integer	Number of configured signing keys

Signing keys are write-only and must have unique identifiers.

Instance media object

Attachment retention overrides the operator has set, and the values in force.

Structure

Field	Type	Description
attachment_decay¹	object	Nullable operator overrides plus an `effective` object of the same keys with concrete values

¹ The override keys are enabled, min_size_mb, max_size_mb, max_eligible_size_mb, min_lifetime_days, max_lifetime_days, curve, renew_threshold_days, and renew_window_days. Each is null when the deployment default applies, and effective reports the value in force. enabled is a boolean, curve is a number from 0 to 1, the _mb keys are positive numbers, and the _days keys are positive safe integers

FiveCord clears max_size_mb when it is not above min_size_mb, clears max_eligible_size_mb when it is below max_size_mb, and clears max_lifetime_days when it is below min_lifetime_days. A cleared key uses the deployment default. The effective size range must have a finite maximum above its minimum, and retention must produce a valid expiry date. Check the returned effective values after an update.

Branding asset kinds

Value	Description
icon	Writes `branding.icon_url`
symbol	Writes `branding.symbol_url`
logo	Writes `branding.logo_url`
wordmark	Writes `branding.wordmark_url`
favicon	Writes `branding.favicon_url`

SMTP test result object

Whether one Create SMTP test connection attempt succeeded, and the failure text when it did not.

Structure

Field	Type	Description
ok	boolean	Whether the server accepted the connection and credentials
error¹	?string	Failure text, or null when the test succeeded

¹ The message reported by the SMTP client, so it can repeat text supplied by the remote server

Example

{
  "ok": false,
  "error": "Invalid login: 535 5.7.8 Authentication credentials invalid"
}

Registration URL creation object

One issued registration URL together with the link an Admin hands out.

Structure

Field	Type	Description
registration_url	registration URL object	Record that was issued
code¹	string	Bearer code that authorises registration (1-256 characters)
url²	string	Complete registration link built from the configured web application endpoint

¹ Equal to registration_url.id, so it can be recovered from any later configuration read

² The configured web application endpoint followed by /register?registration_url= and the percent-encoded code

Limit configuration response object

The effective limit configuration together with the deployment defaults and the metadata an editor needs.

Structure

Field	Type	Description
limit_config	limit configuration object	Effective configuration on the serving node
limit_config_json	string	The same document rendered as JSON indented by two spaces, for an editor to display
self_hosted	boolean	Whether the deployment runs in self-hosted mode
defaults¹	map[string, map[string, integer]]	Deployment default limits, keyed by rule identifier and then by limit key
metadata	map[string, limit key metadata object]	Display metadata for each limit key
categories²	map[string, string]	Display label for each metadata category
limit_keys	array[string]	Every limit key in registry order
bounds?³	map[string, object]	Optional `min` and `max` pair for each limit key

¹ Built for the deployment and the premium mode currently loaded by the serving node. Self-hosted mirror mode includes the premium rule

² The keys are messages, guilds, channels, expressions, files, social, and features

³ Absent from every response

Limit configuration object

Trait definitions and the ordered rules that decide each limit key.

Structure

Field	Type	Description
traitDefinitions	array[string]	Trait names a rule filter can match
rules	array[limit rule object]	Ordered limit rules

The field names are camelCase, unlike the rest of the Admin API.

Limit rule object

One rule in that ordered set, with the filters that scope it and the limits it sets.

Structure

Field	Type	Description
id	string	Rule identifier (at least 1 character)
filters?	object	Optional `traits` and `guildFeatures` string arrays that scope the rule
limits	map[string, integer]	Non-negative value for each limit key the rule sets
modifiedFields?¹	array[string]	Limit keys whose value differs from the deployment default

¹ Compared with the deployment default rule of the same identifier, or with the deployment’s default rule for a custom identifier. A set key absent from that default counts as modified. A rule with no differing key omits the field. Computing this field changes no value in limits

Limit key metadata object

Display metadata for one limit key, which an editor uses to render its control.

Structure

Field	Type	Description
key	string	The limit key
label	string	Display label
description	string	Description of what the limit bounds
category	string	Category key, resolved against `categories`
scope	string	`user`, `guild`, or `both`
isToggle	boolean	Whether the key is a feature gate whose value is 0 or 1
unit?	string	`bytes` or `count`
min?	number	Suggested minimum for an editor
max?	number	Suggested maximum for an editor

Get instance configuration

GET/v1/admin/instance/config

Audit reason

Returns the instance configuration object. Requires instance:config:view, or a session credential until setup is marked complete.

Response

Status	Body	Condition
200	instance configuration object	Configuration was returned

Side effects

The operation records one Admin audit entry with action get_instance_config, target type instance_config, target ID 0, and metadata keys registration_url_count and pending_registration_count. Before setup is complete, a session credential holding no Admin ACL records the entry with its own account as the acting Admin.

Rate limit

200 requests per minute for each authenticated user, on the admin:lookup bucket.

Update instance configuration

PATCH/v1/admin/instance/config

Audit reason

Applies a merge patch to the stored configuration and returns the resulting instance configuration object. Requires instance:config:update, or a session credential until setup is marked complete.

JSON body

Field	Type	Description
sso?¹	object	Every SSO configuration field except `client_secret_set` and `redirect_uri`, plus `client_secret`
gateway_rollout?	object	Any subset of the Gateway rollout configuration fields, each bound as documented there
voice_noise_suppression?	object	Any subset of the noise suppression fields
push_service_delivery?	object	Any subset of the push service delivery fields
domain_migration?	object	Any subset of the domain migration fields
experiment_delivery?	object	Any subset of the experiment delivery fields
registration?	object	`mode` and `admin_registration_urls_enabled`
app_public?²	object	`branding`, `setup`, `legal`, and `registration` sub-objects, each merged field by field
integrations?³	object	`gif`, `youtube`, `captcha`, `email`, and `bluesky` sub-objects, the last of which also has the `keys` array
media?	object	`attachment_decay` overrides, each nullable to restore the deployment default
policy?	instance policy update object	Community, direct message, premium, and gating policy

¹ The supplied fields are merged over the stored configuration and the result is validated as a whole. Every supplied endpoint URL uses https, has no credentials and no fragment, and resolves to a publicly routable address, otherwise the request returns 400 INVALID_FORM_BODY with INVALID_URL_FORMAT or URL_NOT_PUBLICLY_ROUTABLE

² branding.product_name is 1 to 80 characters, every branding and legal URL is at most 2048 characters and nullable, branding.theme_color is at most 64 characters and nullable, and setup.configured and registration.collect_date_of_birth are booleans. Every string is trimmed before it is stored

voice_noise_suppression takes every voice noise suppression configuration field except config_version, each bound as documented there. FiveCord raises config_version by one on each request that supplies at least one of them. A section that is absent, or present with no field set, writes nothing and leaves config_version alone.

push_service_delivery works the same way, over the push service delivery configuration fields and its own config_version.

domain_migration works the same way, over the domain migration configuration fields and its own config_version.

experiment_delivery takes both experiment delivery configuration fields, each bound as documented there. It is a section of its own, so a write to it changes no config_version and changes no assignment, only the cadence on which clients ask for one.

³ A secret such as klipy_api_key, api_key, hcaptcha_secret_key, turnstile_secret_key, or the SMTP password is written when supplied and left alone when absent. integrations.bluesky.keys is the only way to write the Bluesky signing keys counted as bluesky.key_count. It takes up to 8 entries of kid (1-255 characters) and nullable private_key (up to 10000 characters), and replaces the stored key set outright

Instance policy update structure

Field	Type	Description
single_community_enabled?¹	boolean	Whether the deployment presents one community
single_community_name?¹	string	Name used only when the community has to be created (1-100 characters)
direct_messages_disabled?²	boolean	Whether direct messages are disabled
direct_messages_locked?²	boolean	Whether the direct message setting stays locked
premium_mode?	string	Premium mode
services?	object	Nullable `gif_enabled`, `youtube_enabled`, and `bluesky_enabled` overrides
deferred_phone_gate?³	object	`enabled`, `window_hours`, and `member_threshold`

¹ Setting single_community_enabled to true adopts the already designated guild when one still exists. When none is designated or the designated guild was deleted, it creates a community using single_community_name or the configured product name. When the stored guild ID is not a valid ID, or the guild lookup fails for a reason other than an unknown guild, the operation fails and FiveCord creates no community. On a deployment whose setup is already complete, enabling it while no guild is designated fails with 400 INSTANCE_POLICY_TRANSITION_NOT_ALLOWED, as does enabling it when the acting Admin account cannot be resolved. Setting it to false only clears the flag and leaves the guild in place

² The setting can be changed only while direct_messages_locked is false, and a change attempted after the lock is set fails with 400 INSTANCE_POLICY_TRANSITION_NOT_ALLOWED unless the same request sets direct_messages_locked to false. Re-enabling direct messages sets the lock again

³ window_hours is a positive number up to 8760 and member_threshold is a positive integer up to 1000000. An omitted key keeps its stored value

direct_messages_locked accepts only false, and a body that sets it to true fails with 400 INVALID_FORM_BODY.

Response

Status	Body	Condition
200	instance configuration object	The patch was applied
400	error response	A policy transition is refused, returned as `INSTANCE_POLICY_TRANSITION_NOT_ALLOWED`

Side effects

FiveCord publishes a gateway_rollout change to the Gateway cluster. Premium mode changes affect the limits in force without replacing the saved limit configuration. On self-hosted deployments, everyone hides premium-filtered rules. Switching back to mirror restores them unless an Admin has replaced the limit configuration in the meantime. Enabling single community mode creates the community when none is designated, with the acting Admin as owner.

Initial setup completes on the first update that sets app_public.setup.configured to true from a session credential whose account holds neither admin:authenticate nor the wildcard. That update grants the account the wildcard Admin ACL and marks the deployment as bootstrapped.

The operation records one Admin audit entry with action update_instance_config, target type instance_config, and target ID 0. The metadata key sections lists the names of the non-null top-level sections in the body, comma-separated in alphabetical order, and is absent when the body supplies none. The update that completes initial setup and grants the wildcard ACL also records granted_acls as *. No value from the body is recorded. A request that fails part way records no entry.

Rate limit

100 requests per minute for each authenticated user, on the admin:user:modify bucket.

Create branding asset

POST/v1/admin/instance/config/branding-assets

Audit reason

Uploads an image, stores its Media Proxy URL in the selected branding slot, and returns the resulting instance configuration object. Requires instance:config:update, or a session credential until setup is marked complete.

JSON body

Field	Type	Description
kind	string	Branding asset kind naming the slot to write
image?¹ ²	?string	Base64 image or data URI (max 16000000 characters)

¹ Omitting the key and sending null both clear the slot

² The image decodes to no more than the resolved avatar_max_size limit, which defaults to 10485760 bytes, and is a PNG, JPEG, WebP, GIF, APNG, AVIF, HEIC, HEIF, JXL, or SVG. An animated AVIF is refused

Response

Status	Body	Condition
200	instance configuration object	The slot was written or cleared
400¹	error response	The image cannot be decoded, exceeds the size ceiling, or is not an accepted format

¹ Returned as 400 INVALID_FORM_BODY with IMAGE_SIZE_EXCEEDS_LIMIT, INVALID_IMAGE_FORMAT, or FAILED_TO_UPLOAD_IMAGE against image

Side effects

The stored image is served through the Media Proxy. Non-JPEG images are re-encoded to strip metadata and JPEG images are re-encoded at quality 100. The previously referenced image is not deleted.

The operation records one Admin audit entry with action upload_branding_asset, target type instance_config, target ID 0, and metadata keys kind and cleared. cleared is true when the request cleared the slot.

Rate limit

100 requests per minute for each authenticated user, on the admin:user:modify bucket.

Create SMTP test

POST/v1/admin/instance/config/smtp-tests

Audit reason

Opens a connection to the supplied SMTP server, authenticates against it, and reports the outcome as an SMTP test result object without storing anything. Requires instance:config:update, or a session credential until setup is marked complete.

JSON body

Field	Type	Description
host	string	SMTP host to connect to (1-255 characters after trimming)
port	integer	SMTP port to connect to (1-65535)
username	string	SMTP username to authenticate with (1-320 characters after trimming)
password	string	SMTP password to authenticate with (1-4096 characters after trimming)
secure?	boolean	Whether to connect with implicit TLS (default true)

Response

Status	Body	Condition
200	SMTP test result object	The test ran to completion, including a rejected credential

Side effects

No configuration is written and the supplied credentials are discarded when the request completes. The connection, greeting, and socket each have a ten-second deadline.

The operation records one Admin audit entry with action test_smtp_connection, target type instance_config, target ID 0, and metadata keys port, secure, and ok. The host, username, password, and failure text are not recorded.

Rate limit

100 requests per minute for each authenticated user, on the admin:user:modify bucket.

Create registration URL

POST/v1/admin/instance/registration-urls

Audit reason

Issues a registration URL an Admin can hand out while the registration mode is closed or approval, and returns a registration URL creation object. Requires instance:config:update.

JSON body

Field	Type	Description
label?¹	?string	Admin note to attach to the URL (1-120 characters), or null for none
expires_at?	?ISO8601 timestamp	Time the URL stops working, or null for a URL that never expires
max_uses?	?integer	Maximum permitted uses (1-1000000), or null for unlimited use
approval_required?	boolean	Whether an account created through the URL still needs an Admin decision (default false)

¹ The label is trimmed before it is length checked, so a whitespace-only label fails body validation. Omit the key or send null for a URL with no label

Response

Status	Body	Condition
200	registration URL creation object	The URL was issued

Side effects

A newly issued URL has a use count of zero, no revocation time, and the acting Admin as its issuer. It is the first entry of registration.urls on the next configuration read. The operation changes no account.

The operation records one Admin audit entry with action create_registration_url, target type registration_url, target ID 0, and metadata key approval_required, plus max_uses when the body sets it. The label is not recorded. The entry has no registration URL identifier, because the identifier is the bearer code.

Rate limit

100 requests per minute for each authenticated user, on the admin:user:modify bucket.

Revoke registration URL

DELETE/v1/admin/instance/registration-urls/{registration_url_id}

Audit reason

Revokes one registration URL so it can no longer be redeemed and returns the resulting instance configuration object. Requires instance:config:update.

Path parameters

Field	Type	Description
registration_url_id	string	Identifier of the registration URL to revoke (1-128 characters)

Response

Status	Body	Condition
200¹	instance configuration object	The revocation was applied

¹ An identifier naming no registration URL answers 200 with the configuration unchanged. Revoking an already revoked URL keeps the original revocation time

Side effects

The URL records its revocation time and stays in the configuration response afterwards. The operation changes no account.

The operation records one Admin audit entry with action revoke_registration_url, target type registration_url, target ID 0, and no metadata, including for an identifier that names no registration URL. The entry has no registration URL identifier, because the identifier is the bearer code.

Rate limit

100 requests per minute for each authenticated user, on the admin:user:modify bucket.

Update pending registration

PATCH/v1/admin/instance/pending-registrations/{user_id}

Audit reason

Approves or rejects one pending registration and returns the resulting instance configuration object. Requires instance:config:update.

Path parameters

Field	Type	Description
user_id	snowflake	Account awaiting a decision

JSON body

Field	Type	Description
status	string	Either `approved` or `rejected`

Response

Status	Body	Condition
200¹	instance configuration object	The decision was applied

¹ An account that no longer exists still answers 200. The pending registration is removed and no trait is written

Side effects

Approval removes both the registration_pending_approval trait and the registration_rejected trait, and joins the account to the single community when that mode is enabled and a guild is designated. A join that fails is logged and does not fail the request. Rejection removes the registration_pending_approval trait and adds the registration_rejected trait, which blocks login and every later session creation. A session issued before the decision stays valid. The pending registration is removed either way.

When the stored pending registration list fails validation, the request fails before FiveCord changes the account. A failure after FiveCord writes the account traits leaves those traits written and can leave the entry in the pending list. Check the account traits and the pending list before retrying.

One Admin audit entry with the action approve_registration or reject_registration targets the account and records the audit reason. It has no metadata, except for an account that no longer exists, whose entry has the metadata key account_found set to false.

Rate limit

100 requests per minute for each authenticated user, on the admin:user:modify bucket.

Get limit configuration

GET/v1/admin/limit-config

Audit reason

Returns the limit configuration response object. Requires instance:limit_config:view.

Response

Status	Body	Condition
200	limit configuration response object	The configuration was returned

Side effects

The response reflects the configuration in force on the node that serves the request, so two nodes can report different values while a change propagates.

The operation records one Admin audit entry with action get_limit_config, target type limit_config, target ID 0, and metadata key rule_count.

Rate limit

200 requests per minute for each authenticated user, on the admin:lookup bucket.

Replace limit configuration

PUT/v1/admin/limit-config

Audit reason

Replaces the stored limit configuration with the supplied document and returns the resulting limit configuration response object. Requires instance:limit_config:update.

JSON body

Field	Type	Description
limit_config¹	limit configuration object	Complete replacement document

¹ traitDefinitions can be omitted and is then stored as an empty array. Every key inside a rule’s limits map is a known limit key and every value is a non-negative safe integer, otherwise the body fails validation. modifiedFields is not accepted on input and is recomputed

Response

Status	Body	Condition
200	limit configuration response object	The configuration was replaced
400	error response	Body validation fails, including an unknown limit key, returned as `INVALID_FORM_BODY`

Side effects

On a self-hosted deployment whose premium mode is everyone, FiveCord drops the premium trait definition and every rule filtered on the premium trait before storing the document.

Each rule’s modifiedFields is then recomputed and the merged document replaces the stored one. Every API node adopts the new configuration. Clients observe it through the published limit configuration.

The operation records one Admin audit entry with action update_limit_config, target type limit_config, target ID 0, and metadata keys rule_count, changed_rule_count, and trait_definition_count, each taken from the stored document. changed_rule_count is the number of rule identifiers added, removed, or stored with different filters or limits, compared with the configuration the serving node held before the write.

Rate limit

100 requests per minute for each authenticated user, on the admin:user:modify bucket.