Repository navigation
currently undocumented #1211
Description
webhooks
- 4.0.0 admin webhooks Add administrative webhooks mastodon#18510
- 4.1.0
account.approvedwebhook Add webhookaccount.approvedmastodon#22938 - 4.2.0
report.updatedAdd report.updated webhook mastodon#24211
api
- 4.1.0
hide_collectionsparam on PATCH account/update_credentials Allow changing hide_collections setting with the api mastodon#22790 - 4.1.0
roleson Account entity Addrolesattribute to Account entities in REST API mastodon#23255 - 4.1.0
requested_byon Relationship entity Add follow request banner on account header mastodon#20785 - 4.1.0
policyon WebPushSubscription entity Add missingpolicyattribute toWebPushSubscriptionSerializermastodon#23210 - 4.1.0
reading:autoplay:gifson api/v1/preferences (but not update_credentials?) https://github.com/mastodon/mastodon/pull/22706/files - 4.1.0 use RoleSerializer for Admin::Account Fix unserialized
roleon account entities in admin API mastodon#23290 - 4.1.0 notifications limit raised from 15/30 to 40/80 Change notifications per page from 15 to 40 in REST API mastodon#23348
- 4.1.0 api rate limit per account 300 -> 1500 (new limit 300 per token) Change rate limits to 1,500/5m per user, 300/5m per app mastodon#23347
- 4.1.0 streaming/metrics Add metrics endpoint to streaming API mastodon#23388
- 4.1.0
configuration.urls.statuson api/v2/instance (the changelog is wrong, it claims v1 instead) Add setting for status page URL mastodon#23390 - 4.1.0
PUT /api/v1/statuses/:idnow takes an extramedia_attributes[]array parameter with theidof the updated media and their updateddescription,focus, andthumbnailAdd support for editing media description and focus point of already-posted statuses mastodon#20878 - 4.2
safeguard_mentionsonPOST /api/v1/statusesAdd API parameter to safeguard unexpect mentions in new posts mastodon#18350 - 4.2
memorialon Account entity Addmemorialattribute to REST API mastodon#23591 - 4.2 trends management api Add trend management to admin API mastodon#24257
- 4.2 statuses/:id/history now returns at least one item when status is edited (the latest edit, at least) Change /api/v1/statuses/:id/history to always return at least one item mastodon#25510
- 4.2 mark conversation unread Add POST /api/v1/conversations/:id/unread mastodon#25509
- 4.2
forward_to_domainsonPOST /api/v1/reportsAddforward_to_domainsparameter toPOST /api/v1/reportsmastodon#25866 - 4.2 api/v1/instance/languages Add
GET /api/v1/instance/languagesto REST API mastodon#24443 - 4.2
CredentialAccountentity now includes more params Addhide_collections,discoverableandindexableattributes to credentials API mastodon#26998 - 4.3
hide_collectionson Account entity (used to show a different placeholder text) Fix Web UI not displaying appropriate explanation when a user hides their follows/followers mastodon#27791 - 4.3
allow_with_approvalon email_domain_blocks API Add ability to require approval when users sign up using specific email domains mastodon#28468 - 4.3 Add
api/v1/annual_reportsAdd annual reports for accounts mastodon#28693 - 4.3 Add
digesttoadmin/domain_blocksReturn domain block digests from admin domain blocks API mastodon#29092 - 4.3
sourcesproperty on api/v2/suggestions Changesourceattribute ofSuggestionentity in/api/v2/suggestionsback to a string mastodon#29108 - 4.3 notification requests and policies Add notification policies and notification requests mastodon#29366
- 4.3 notification policies v2 Revamp notification policy options mastodon#31343
- 4.3 api/v1/timelines/link Add timeline of public posts about a trending link to REST API mastodon#30381
- 4.3
filteredattribute on notifications Add optionalfilteredattribute to notification entities in REST API mastodon#31011 - 4.4 annual reports API Add year in review feature to web UI mastodon#32709
things to test / document
- setting an invalid
in_reply_to_idwhen doingPOST /api/v1/statuses"Publish new status" docs don't specify possible error messages mastodon#13473
env
- 4.1.0 SIDEKIQ_CONCURRENCY Add environment variable to configure sidekiq concurrency mastodon#19589
- 4.1.0 DB_POOL Add database pool configuration over
DB_POOLto streaming API mastodon#23470 - 4.1.0 MIN_THREADS Add ability to set minimum Puma threads with MIN_THREADS environment variable mastodon#21048
tootctl
- 4.1.0
media removehas new flags Add command to remove avatar and header images of inactive remote accounts from the local database mastodon#22149 - 4.1.0
accounts deletehas new flags Add --email and --dry-run options totootctl accounts deletemastodon#22328 - 4.1.0
accounts migrateAddtootctl accounts migratemastodon#22330 - 4.1.0
accounts pruneImplement tootctl accounts prune mastodon#18397 - 4.1.0
domains purgeAddtootctl domains purgeoptions to select subdomains and keep domain blocks mastodon#22063 - 4.2 new option for ip_blocks tootctl Add ability to block sign-ups from IP using the CLI mastodon#24870
- 4.2 tootctl
accounts createhas new flag--approvetootctl: add --approve option to tootctl accounts create mastodon#24533 - 4.2 tootctl
accounts approve --numbersorting was not guaranteed; now it is Fixtootctl accounts approve --number Nnot aproving N earliest registrations mastodon#24605
???
- 3.3.0 object storage failure now returns 503 in some API methods
-
3.2.0 /api/v1/crypto added but commented out-
4.3.0 removed entirely
-
user guide
- "lock account" is now "require follow requests"
- "list this account on the directory" is now "suggest account to others"
- "hide your network" is now "hide your social graph"
- change order of dropdown menu on posts to be more intuitive in web UI
- change option labels on edit profile page
- change max image dimensions (previously 1280px square, then 1920x1080 unless Change image matrix size limit from 1920×1080px to 4096×4096px mastodon#23322 is merged, but then Change media upload limits and remove client-side resizing mastodon#23726 got merged)
- can now upload webp, wave, avif, heic
- custom emoji limit raised from 50kb to 256kb
- authentication history
- automatically delete old posts
- filter search results by author, using
from:syntax - hint about missing media attachment descriptions
- timed mutes
- private boosts
- explore page
- relationship manager
- hashtag normalization
- full text search params
- attribution domains
- lists
admin guide
- figure out what's out of date, if any
- 4.0.0 authorized_fetch tips need to be updated?
- figure out SSO stuff
- install guide - prefer SMTP_TLS over SMTP_ENABLE_STARTTLS? SMTP configuration incorrect in installer - with fix mastodon#23180
- OpenID Connect support Allow login through OpenID Connect mastodon#16221
project dev guide
client dev guide
technical
- add
CONTRIBUTING.md - note that mf2 (microformats 2) is removed?
- nodeinfo?
- rss?
- clarify stuff around ld sigs
- clarify update_credentials vs preferences (especially when it comes to changing those values via PUT/PATCH) Link between /api/v1/preferences and /api/v1/accounts/update_credentials #1152
- clarify that ids are not "string representations of numbers" Proposal: Relax the requirement that IDs must be "string representations of numbers" mastodon#25244
- 4.2
toot:indexableflag Add support forindexableattribute on remote actors mastodon#26485 - 4.2
memorialnow federates astoot:memorialAdd support for federatingmemorialattribute mastodon#26583
Reacted by nemobis, Jorge M. Carvalho 🐳, Stefan Bohacek and Max
Reacted by Andy Piper, Manu, Jonathan de Jong and 1Haschwalth
Activity
andypiper commentedon Dec 10, 2023
@trwnh I started to check a few of these off based on some of the recent doc PRs (thinking the list items could be switched over to checklist items). Thanks for keeping this list here!
andypiper commentedon Dec 11, 2023
Now switched to checklist format 👍🏻 just for convenience of checking things off as updates are merged.
ThisIsMissEm commentedon May 17, 2024
FYI, I'm tracking all the unreleased OAuth changes in #1445
ThisIsMissEm commentedon May 17, 2024
@colleenpridemore at the bottom of the email from github there's an unsubscribe link, or on web in the sidebar of this issue you can manage your subscription – I can't managed that for you
ThisIsMissEm commentedon May 17, 2024
Docs for 4.3 Add digest to admin/domain_blocks mastodon/mastodon#29092 are in #1417 which is merged.
ThisIsMissEm commentedon May 17, 2024
On 4.1.0 streaming/metrics, I've started docs here, since between 4.1.0 and now, we've switched Streaming to use the proper prometheus module: #1213
I also have a grafana dashboard for Streaming metrics, but I don't know how to make this distributable; but that could go in
dist/in the main repo thenThisIsMissEm commentedon Jun 9, 2024
Another undocumented endpoint seems to be
Api::V1::Timelines::LinkControlleratGET /api/v1/timelines/linkaaaaalbert commentedon Aug 8, 2024
Since 325dc1f, you may tick off
CONTRIBUTING.md.Reeceeboii commentedon Aug 24, 2024
https://docs.joinmastodon.org/entities/Instance/#registrations
registrations[url]is currently undocumented (/app/serializers/rest/instance_serializer.rb#L106)shuuji3 commentedon Aug 24, 2024
For reference, the above
registrations[url]was introduced by this PR: mastodon/mastodon#25014ThisIsMissEm commentedon Nov 17, 2024
@trwnh we can remove all references to crypto from this todo list, as we completely removed crypto APIs for 4.3.0 — e.g.,
/api/v1/crypto(the scope has already been removed)trwnh commentedon Nov 17, 2024
@ThisIsMissEm there's only one reference and it's to note that it was added in 3.2.0 but commented out. i guess if we ever do document it we can then say it was removed entirely in 4.3.0? maybe just a link to the PR will suffice for interested people
ThisIsMissEm commentedon Nov 17, 2024
@trwnh I would not bother documenting it: it was never used anywhere, never documented, never promoted, and I'm not sure if we even knew if it was feature complete?
trwnh commentedon Nov 17, 2024
@ThisIsMissEm "documenting" in this case doesn't have to be full API docs, it could just be a one-line mention that this existed at some point even if never used. think of it as a sort of "historical footnote"
ThisIsMissEm commentedon Nov 17, 2024
@trwnh yeah, and I'm saying that I don't think we even need that footnote for something that was never ready for use. No client support unless you somehow found it in the codebase, and even then it wasn't clear how you actually used it. Additionally adding it now may conflict with potential E2EE from the taskforce on that.
ThisIsMissEm commentedon Nov 17, 2024
Maybe here we could add a line about deprecating that
cryptoscope though? https://docs.joinmastodon.org/api/oauth-scopes/#versionswezm commentedon Jun 26, 2025
It also seems there's no coverage of lists in the user guide, perhaps this could be added to the checklist at the top too.
englut commentedon Aug 26, 2025
There's a gap in documentation surrounding docker compose and how to run mastodon in it. Given that amount of instance admins that have trouble keeping all the different software up-to-date throughout the upgrades (and how simple the release notes for docker is in comparison)... Giving people documentation to start with Docker (or at least an alternative recommendation to the bare metal approach) would probably save so much time for people needing to support all the questions and requests for help when there's a upgrade that requires many software updates (or replacements; e.g. ImageMagick -> libvips).
IMO, docker compose should be the recommended approach for instance admins to run mastodon, but I am aware there's probably challenges to switching to that recommendation.
philhoefer commentedon Jun 5, 2026
PreviewCard items have a language attribute that seems to be undocumented.
tmr5blog-ux commentedon Oct 19, 2026