Mastodon
  • What is Mastodon?
  • Using Mastodon
    • Signing up for an account
    • Setting up your profile
    • Posting toots
    • 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
    • Installing optional features
      • Full-text search
      • Hidden services
      • Single Sign On
    • Setting up your new instance
    • Using the admin CLI
    • Upgrading to a new release
    • Backing up your server
    • Migrating to a new machine
    • 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
    • Guidelines and best practices
    • 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
    • OAuth Scopes
    • Rate limits
  • API Methods
    • apps
      • oauth
    • accounts
      • bookmarks
      • favourites
      • mutes
      • blocks
      • domain_blocks
      • filters
      • reports
      • follow_requests
      • endorsements
      • featured_tags
      • preferences
      • suggestions
    • statuses
      • media
      • polls
      • scheduled_statuses
    • timelines
      • conversations
      • lists
      • markers
      • streaming
    • notifications
      • push
    • search
    • instance
      • trends
      • directory
      • custom_emojis
    • admin
    • announcements
    • proofs
    • oembed
  • API Entities
    • Account
    • Activity
    • Admin::Account
    • Admin::Report
    • Announcement
    • AnnouncementReaction
    • Application
    • Attachment
    • Card
    • Context
    • Conversation
    • Emoji
    • Error
    • FeaturedTag
    • Field
    • Filter
    • History
    • IdentityProof
    • Instance
    • List
    • Marker
    • Mention
    • Notification
    • Poll
    • Preferences
    • PushSubscription
    • Relationship
    • Report
    • Results
    • ScheduledStatus
    • Source
    • Status
    • Tag
    • Token

Instance

Represents the software instance of Mastodon running on this domain.

    • Example
    • Required attributes
    • Optional attributes
    • See also

Example


  "uri": "mastodon.social",
  "title": "Mastodon",
  "short_description": "Server run by the main developers of the project <img draggable=\"false\" alt=\"馃悩\" class=\"emojione\" src=\"https://mastodon.social/emoji/1f418.svg\" /> It is not focused on any particular niche interest - everyone is welcome as long as you follow our code of conduct!",
  "description": "Server run by the main developers of the project <img draggable=\"false\" alt=\"馃悩\" class=\"emojione\" src=\"https://mastodon.social/emoji/1f418.svg\" /> It is not focused on any particular niche interest - everyone is welcome as long as you follow our code of conduct!",
  "email": "staff@mastodon.social",
  "version": "3.0.1",
  "urls": {
    "streaming_api": "wss://mastodon.social"
  },
  "stats": {
    "user_count": 415526,
    "status_count": 17085754,
    "domain_count": 11834
  },
  "thumbnail": "https://files.mastodon.social/site_uploads/files/000/000/001/original/vlcsnap-2018-08-27-16h43m11s127.png",
  "languages": [
    "en"
  ],
  "registrations": true,
  "approval_required": false,
  "contact_account": {
    "id": "1",
    "username": "Gargron",
    "acct": "Gargron",
    "display_name": "Eugen",
    "locked": false,
    "bot": false,
    "created_at": "2016-03-16T14:34:26.392Z",
    "note": "<p>Developer of Mastodon and administrator of mastodon.social. I post service announcements, development updates, and personal stuff.</p>",
    "url": "https://mastodon.social/@Gargron",
    "avatar": "https://files.mastodon.social/accounts/avatars/000/000/001/original/d96d39a0abb45b92.jpg",
    "avatar_static": "https://files.mastodon.social/accounts/avatars/000/000/001/original/d96d39a0abb45b92.jpg",
    "header": "https://files.mastodon.social/accounts/headers/000/000/001/original/c91b871f294ea63e.png",
    "header_static": "https://files.mastodon.social/accounts/headers/000/000/001/original/c91b871f294ea63e.png",
    "followers_count": 317112,
    "following_count": 453,
    "statuses_count": 60903,
    "last_status_at": "2019-11-26T21:14:44.522Z",
    "emojis": [],
    "fields": [
      {
        "name": "Patreon",
        "value": "<a href=\"https://www.patreon.com/mastodon\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://www.</span><span class=\"\">patreon.com/mastodon</span><span class=\"invisible\"></span}",
        "verified_at": null
      },
      {
        "name": "Homepage",
        "value": "<a href=\"https://zeonfederated.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">zeonfederated.com</span><span class=\"invisible\"></span}",
        "verified_at": "2019-07-15T18:29:57.191+00:00"
      }
    ]
  }
}

Required attributes

uri

Description: The domain name of the instance.
Type: String
Version history: Added in 1.1.0

title

Description: The title of the website.
Type: String
Version history: Added in 1.1.0

description

Description: Admin-defined description of the Mastodon site.
Type: String
Version history: Added in 1.1.0

short_description

Description: A shorter description defined by the admin.
Type: String
Version history: Added in 2.9.2

email

Description: An email that may be contacted for any inquiries.
Type: String
Version history: Added in 1.1.0

version

Description: The version of Mastodon installed on the instance.
Type: String
Version history: Added in 1.3.0

languages

Description: Primary languages of the website and its staff.
Type: Array of String (ISO 639 Part 1-5 language codes)
Version history: Added in 2.3.0

registrations

Description: Whether registrations are enabled.
Type: Boolean
Version history: Added in 2.7.2

approval_required

Description: Whether registrations require moderator approval.
Type: Boolean
Version history: Added in 2.9.2

invites_enabled

Description: Whether invites are enabled.
Type: Boolean
Version history: Added in 3.1.4

urls

Description: URLs of interest for clients apps.
Type: Hash (streaming_api)
Version history: Added in 1.4.2

urls[streaming_api]

Websockets address for push streaming. String (URL).

stats

Description: Statistics about how much information the instance contains.
Type: Hash (user_count, status_count, domain_count)
Version history: Added in 1.6.0

user_count

Users registered on this instance. Number.

status_count

Statuses authored by users on instance. Number.

domain_count

Domains federated with this instance. Number.

Optional attributes

thumbnail

Description: Banner image for the website.
Type: String (URL) or null
Version history: Added in 1.6.1

contact_account

Description: A user that can be contacted, as an alternative to email.
Type: Account or null
Version history: Added in 2.3.0

See also

instance
app/serializers/rest/instance_serializer.rb

Last updated March 12, 2022 路 Improve this page

Sponsored by

Dotcom-Monitor LoadView Stephen Tures Swayable

Join Mastodon 路 Blog 路 路

View source 路 CC BY-SA 4.0 路 Imprint