Skip to content

AdminSetting

An instance setting: its value and what it accepts. Every value is a string in its canonical form, whatever its kind.

object
key
required

The key of an instance setting. New keys may be added; clients show the ones they know.

string
Allowed values: registration_mode max_status_length default_locale local_timeline_visibility federated_timeline_visibility preview_image contact_account contact_email thumbnail remote_media_policy remote_media_cache_ttl_seconds authorized_fetch domain_actions_visibility domain_actions_rationale_visibility appeal_window_days session_origins_retention_days registration_origins_retention_days reports_retention_days moderation_actions_retention_days audit_log_retention_days search_indexing ai_usage indexable_default search_visibilities security_contact require_media_description link_cards link_cards_ignore_robots_txt finance_visibility finance_viewer_item_names finance_viewer_item_memos finance_viewer_income supporter_list_visibility income_visibility federation_mode federation_scope user_app_registration dynamic_client_registration oauth_metadata_document_clients voice_room_starters voice_public_summary voice_participants_retention_days hook_inbound_status_mode hook_inbound_follow_mode hook_signup_check_mode hook_media_check_mode hook_local_status_mode hook_inbound_actor_mode hook_local_profile_mode hook_inbound_status_on_failure hook_inbound_status_unfollowed_direct hook_inbound_follow_on_failure hook_signup_check_on_failure hook_signup_check_reject hook_local_status_account_age_days hook_local_profile_account_age_days hook_media_check_on_failure hook_inbound_actor_on_failure hook_decisions_retention_days invite_creators member_invite_max_active member_invite_max_uses member_invite_max_lifetime_seconds public_counts landing_fediverse_explanation landing_features featured_accounts login_providers_only remote_media_cache_max_bytes remote_status_retention_days remote_status_max_retention_days relay_status_retention_days oauth_client_rate_limits translation_providers translation_provider_visibilities translation_browser translation_user_monthly_characters translation_server_monthly_characters translation_retention_days translation_reports_to_server auto_delete_default_enabled auto_delete_default_min_age_days auto_delete_default_keep_pinned auto_delete_default_keep_bookmarked auto_delete_default_keep_favourited auto_delete_default_keep_media auto_delete_default_keep_polls auto_delete_default_keep_public auto_delete_default_keep_local auto_delete_default_keep_unlisted auto_delete_default_keep_private auto_delete_default_keep_direct auto_delete_default_keep_min_boosts auto_delete_default_keep_min_favourites auto_delete_max_age_days auto_delete_max_allow_pinned auto_delete_max_kept_pins auto_delete_max_allow_bookmarked auto_delete_max_allow_favourited auto_delete_max_allow_media auto_delete_max_allow_polls auto_delete_max_allow_visibilities auto_delete_max_allow_thresholds auto_delete_grace_days single_user max_drafts max_scheduled_posts max_scheduled_posts_per_day scheduled_post_min_lead_minutes scheduled_post_max_lead_days article_authoring max_article_bytes max_article_images auto_delete_default_keep_articles auto_delete_max_allow_articles event_creators event_records_retention_days funding_meter_visibility funding_meter_target_amount funding_meter_target_currency funding_meter_rail ux_measurement ux_measurement_share
kind
required

The type of a setting’s value. bool: true or false. int: a decimal integer from minimum to maximum. enum: one of choices. locale: a BCP 47 language tag. media: the ID of an image uploaded with POST /media, or empty for none. account: the username of a local account, or empty for none. email: an email address such as admin@example.com, or empty for none. uri: an https: or mailto: URI, or empty for none. accounts: the usernames of up to 20 local accounts separated by spaces (commas and a leading @ are accepted), in order, or empty for none. client_limits: comma-separated client_id=requests pairs, or empty for none. provider_list: comma-separated translation provider IDs, the first tried first, or empty for none. provider_visibilities: comma-separated provider=visibility|visibility pairs, or empty for none. decimal: a decimal number that is not negative in the major unit of a currency (1650, 12.34), or empty for none. currency: an ISO 4217 code such as JPY, or empty for none.

string
Allowed values: bool int enum locale media account email uri accounts client_limits provider_list provider_visibilities decimal currency
value
required

The current value, which is default when stored is false.

string
default
required

The value of the setting while it has never been set.

string
stored
required

Whether the setting has been set; false means its default applies.

boolean
choices

The values an enum setting accepts, in order; omitted for other kinds.

Array<string>
minimum

The least value of an int setting; omitted for other kinds.

integer
maximum

The greatest value of an int setting; omitted for other kinds.

integer
image

For a media setting with a value, its image, so that a client can show what is set whoever uploaded it; omitted for other kinds, for none, and while the file is processing or is not an image.

Schema: AdminSettingImage

object

Example generated

{
"key": "registration_mode",
"kind": "bool",
"value": "example",
"default": "example",
"stored": true,
"choices": [
"example"
],
"minimum": 1,
"maximum": 1,
"image": {}
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site