documentation

  • Join Mastodon
  • Read our blog
  • mastodon/mastodon
  • Become a patron
    Skip menu
  • What is Mastodon?
  • Using Mastodon
    • Signing up for an account
    • Setting up your profile
    • Posting to your profile
    • Using the network features
    • Dealing with unwanted content
    • Promoting yourself and others
    • Set your preferences
    • More settings
    • Using Mastodon externally
    • Moving or leaving accounts
    • Running your own server
    Running Mastodon
    • Preparing your machine
    • Installing from source
    • Configuring your environment
    • Setting up your new instance
    • Using the admin CLI
    • Upgrading to a new release
    • Backing up your server
    • Migrating to a new machine
    • Optional features
      • Full-text search
      • Configuring object storage
      • Hidden services
      • Single Sign On
    • Scaling up your server
    • Moderation actions
    • Troubleshooting errors
      • Database index corruption
    Developing Mastodon apps
    • Getting started with the API
    • Playing with public data
    • Obtaining client app access
    • Logging in with an account
    • Libraries and implementations
    Contributing to Mastodon
    • Technical overview
    • Setting up a dev environment
    • Code structure
    • Routes
    • Bug bounties and responsible disclosure
    Spec compliance
    • ActivityPub
    • WebFinger
    • Security
    • Microformats
    • OAuth
    • Bearcaps
    REST API
    • Guidelines and best practices
    • OAuth Scopes
    • Rate limits
    API Methods
    • apps
      • oauth
      • emails
    • accounts
      • bookmarks
      • favourites
      • mutes
      • blocks
      • domain_blocks
      • filters
      • reports
      • follow_requests
      • endorsements
      • featured_tags
      • preferences
      • followed_tags
      • suggestions
      • tags
    • statuses
      • media
      • polls
      • scheduled_statuses
    • timelines
      • conversations
      • lists
      • markers
      • streaming
    • notifications
      • push
    • search
    • instance
      • trends
      • directory
      • custom_emojis
      • announcements
    • admin
      • admin/accounts
      • admin/domain_blocks
      • admin/reports
      • admin/trends
      • canonical_email_blocks
      • dimensions
      • domain_allows
      • email_domain_blocks
      • ip_blocks
      • measures
      • retention
    • proofs
    • oembed
    API Entities
    • Account
    • Admin::Account
    • Admin::CanonicalEmailBlock
    • Admin::Cohort
    • Admin::Dimension
    • Admin::DomainAllow
    • Admin::DomainBlock
    • Admin::EmailDomainBlock
    • Admin::Ip
    • Admin::IpBlock
    • Admin::Measure
    • Admin::Report
    • Announcement
    • Application
    • Context
    • Conversation
    • CustomEmoji
    • DomainBlock
    • Error
    • ExtendedDescription
    • FamiliarFollowers
    • FeaturedTag
    • Filter
    • FilterKeyword
    • FilterResult
    • FilterStatus
    • IdentityProof
    • Instance
    • List
    • Marker
    • MediaAttachment
    • Notification
    • Poll
    • Preferences
    • PreviewCard
    • Reaction
    • Relationship
    • Report
    • Role
    • Rule
    • ScheduledStatus
    • Search
    • Status
    • StatusEdit
    • StatusSource
    • Suggestion
    • Tag
    • Token
    • Translation
    • V1::Filter
    • V1::Instance
    • WebPushSubscription

admin API methods

admin/accounts API methods

Perform moderation actions with accounts.

December 18, 2022

admin/domain_blocks API methods

Disallow certain domains to federate.

December 18, 2022

admin/reports API methods

Perform moderation actions with reports.

December 18, 2022

admin/trends API methods

TODO

December 18, 2022

canonical_email_blocks API methods

Block certain email addresses by their hash.

December 18, 2022

dimensions API methods

Obtain qualitative metrics about the server.

December 18, 2022

domain_allows API methods

Allow certain domains to federate.

December 18, 2022

email_domain_blocks API methods

Disallow certain email domains from signing up.

December 18, 2022

ip_blocks API methods

Disallow certain IP address ranges from signing up.

December 18, 2022

measures API methods

Obtain quantitative metrics about the server.

December 18, 2022

retention API methods

Show retention data over time.

December 18, 2022

  • Imprint
  • View source
back to top