Mastodon
  • 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
    • Installing optional features
      • Full-text search
      • Configuring object storage
      • 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
    • 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

V1::Instance

Represents the software instance of Mastodon running on this domain.

    • Example
    • Attributes
      • uri
      • title
      • short_description
      • description
      • email
      • version
      • urls
      • stats
      • thumbnail
      • languages
      • registrations
      • approval_required
      • invites_enabled
      • configuration
      • contact_account
      • rules
    • See also

Example

{
  "uri":"mastodon.social",
  "title":"Mastodon",
  "short_description":"The original server operated by the Mastodon gGmbH non-profit",
  "description":"",
  "email":"staff@mastodon.social",
  "version":"3.5.3",
  "urls":{
    "streaming_api":"wss://mastodon.social"
  },
  "stats":{
    "user_count":812303,
    "status_count":38151616,
    "domain_count":25255
  },
  "thumbnail":"https://files.mastodon.social/site_uploads/files/000/000/001/original/vlcsnap-2018-08-27-16h43m11s127.png",
  "languages":[
    "en"
  ],
  "registrations":false,
  "approval_required":false,
  "invites_enabled":true,
  "configuration":{
    "statuses":{
      "max_characters":500,
      "max_media_attachments":4,
      "characters_reserved_per_url":23
    },
    "media_attachments":{
      "supported_mime_types":[
        "image/jpeg",
        "image/png",
        "image/gif",
        "image/webp",
        "video/webm",
        "video/mp4",
        "video/quicktime",
        "video/ogg",
        "audio/wave",
        "audio/wav",
        "audio/x-wav",
        "audio/x-pn-wave",
        "audio/vnd.wave",
        "audio/ogg",
        "audio/vorbis",
        "audio/mpeg",
        "audio/mp3",
        "audio/webm",
        "audio/flac",
        "audio/aac",
        "audio/m4a",
        "audio/x-m4a",
        "audio/mp4",
        "audio/3gpp",
        "video/x-ms-asf"
      ],
      "image_size_limit":10485760,
      "image_matrix_limit":16777216,
      "video_size_limit":41943040,
      "video_frame_rate_limit":60,
      "video_matrix_limit":2304000
    },
    "polls":{
      "max_options":4,
      "max_characters_per_option":50,
      "min_expiration":300,
      "max_expiration":2629746
    }
  },
  "contact_account":{
    "id":"1",
    "username":"Gargron",
    "acct":"Gargron",
    "display_name":"Eugen",
    "locked":false,
    "bot":false,
    "discoverable":true,
    "group":false,
    "created_at":"2016-03-16T00:00:00.000Z",
    "note":"\u003cp\u003eFounder, CEO and lead developer \u003cspan class=\"h-card\"\u003e\u003ca href=\"https://mastodon.social/@Mastodon\" class=\"u-url mention\"\u003e@\u003cspan\u003eMastodon\u003c/span\u003e\u003c/a\u003e\u003c/span\u003e, Germany.\u003c/p\u003e",
    "url":"https://mastodon.social/@Gargron",
    "avatar":"https://files.mastodon.social/accounts/avatars/000/000/001/original/dc4286ceb8fab734.jpg",
    "avatar_static":"https://files.mastodon.social/accounts/avatars/000/000/001/original/dc4286ceb8fab734.jpg",
    "header":"https://files.mastodon.social/accounts/headers/000/000/001/original/3b91c9965d00888b.jpeg",
    "header_static":"https://files.mastodon.social/accounts/headers/000/000/001/original/3b91c9965d00888b.jpeg",
    "followers_count":118944,
    "following_count":305,
    "statuses_count":72309,
    "last_status_at":"2022-08-24",
    "emojis":[
      
    ],
    "fields":[
      {
        "name":"Patreon",
        "value":"\u003ca href=\"https://www.patreon.com/mastodon\" target=\"_blank\" rel=\"nofollow noopener noreferrer me\"\u003e\u003cspan class=\"invisible\"\u003ehttps://www.\u003c/span\u003e\u003cspan class=\"\"\u003epatreon.com/mastodon\u003c/span\u003e\u003cspan class=\"invisible\"\u003e\u003c/span\u003e\u003c/a\u003e",
        "verified_at":null
      }
    ]
  },
  "rules":[
    {
      "id":"1",
      "text":"Sexually explicit or violent media must be marked as sensitive when posting"
    },
    {
      "id":"2",
      "text":"No racism, sexism, homophobia, transphobia, xenophobia, or casteism"
    },
    {
      "id":"3",
      "text":"No incitement of violence or promotion of violent ideologies"
    },
    {
      "id":"4",
      "text":"No harassment, dogpiling or doxxing of other users"
    },
    {
      "id":"5",
      "text":"No content illegal in Germany"
    },
    {
      "id":"7",
      "text":"Do not share intentionally false or misleading information"
    }
  ]
}

Attributes

uri

Description: The domain name of the instance.
Type: String
Version history:
1.1.0 - added

title

Description: The title of the website.
Type: String
Version history:
1.1.0 - added

short_description

Description: A short, plain-text description defined by the admin.
Type: String
Version history:
2.9.2 - added

description

Description: An HTML-permitted description of the Mastodon site.
Type: String
Version history:
1.1.0 - added

email

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

version

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

urls

Description: URLs of interest for clients apps.
Type: Hash
Version history:
1.4.2 - added

urls[streaming_api]

Description: The Websockets URL for connecting to the streaming API.
Type: String (URL)
Version history:
1.4.2 - added

stats

Description: Statistics about how much information the instance contains.
Type: Hash
Version history:
1.6.0 - added

stats[user_count]

Description: Total users on this instance.
Type: Integer
Version history:
1.6.0 - added

stats[status_count]

Description: Total statuses on this instance.
Type: Integer
Version history:
1.6.0 - added

stats[domain_count]

Description: Total domains discovered by this instance.
Type: Integer
Version history:
1.6.0 - added

thumbnail

Description: Banner image for the website.
Type: nullable String (URL)
Version history:
1.6.1 - added

languages

Description: Primary languages of the website and its staff.
Type: Array of String (ISO 639-1 two-letter code)
Version history:
2.3.0 - added

registrations

Description: Whether registrations are enabled.
Type: Boolean
Version history:
2.7.2 - added

approval_required

Description: Whether registrations require moderator approval.
Type: Boolean
Version history:
2.9.2 - added

invites_enabled

Description: Whether invites are enabled.
Type: Boolean
Version history:
3.1.4 - added

configuration

Description: Configured values and limits for this website.
Type: Hash
Version history:
3.4.2 - added

configuration[accounts]

Description: Limits related to accounts.
Type: Hash
Version history:
4.0.0 - added

configuration[accounts][max_featured_tags]

Description: The maximum number of featured tags allowed for each account.
Type: Integer
Version history:
4.0.0 - added

configuration[statuses]

Description: Limits related to authoring statuses.
Type: Hash
Version history:
3.4.2 - added

configuration[statuses][max_characters]

Description: The maximum number of allowed characters per status.
Type: Integer
Version history:
3.4.2 - added

configuration[statuses][max_media_attachments]

Description: The maximum number of media attachments that can be added to a status.
Type: Integer
Version history:
3.4.2 - added

configuration[statuses][characters_reserved_per_url]

Description: Each URL in a status will be assumed to be exactly this many characters.
Type: Integer
Version history:
3.4.2 - added

configuration[media_attachments]

Description: Hints for which attachments will be accepted.
Type: Hash
Version history:
3.4.2 - added

configuration[media_attachments][supported_mime_types]

Description: Contains MIME types that can be uploaded.
Type: Array of String
Version history:
3.4.2 - added

configuration[media_attachments][image_size_limit]

Description: The maximum size of any uploaded image, in bytes.
Type: Integer
Version history:
3.4.2 - added

configuration[media_attachments][image_matrix_limit]

Description: The maximum number of pixels (width times height) for image uploads.
Type: Integer
Version history:
3.4.2 - added

configuration[media_attachments][video_size_limit]

Description: The maximum size of any uploaded video, in bytes.
Type: Integer
Version history:
3.4.2 - added

configuration[media_attachments][video_frame_rate_limit]

Description: The maximum frame rate for any uploaded video.
Type: Integer
Version history:
3.4.2 - added

configuration[media_attachments][video_matrix_limit]

Description: The maximum number of pixels (width times height) for video uploads.
Type: Integer
Version history:
3.4.2 - added

configuration[polls]

Description: Limits related to polls.
Type: Hash
Version history:
3.4.2 - added

configuration[polls][max_options]

Description: Each poll is allowed to have up to this many options.
Type: Integer
Version history:
3.4.2 - added

configuration[polls][max_characters_per_option]

Description: Each poll option is allowed to have this many characters.
Type: Integer
Version history:
3.4.2 - added

configuration[polls][min_expiration]

Description: The shortest allowed poll duration, in seconds.
Type: Integer
Version history:
3.4.2 - added

configuration[polls][max_expiration]

Description: The longest allowed poll duration, in seconds.
Type: Integer
Version history:
3.4.2 - added

contact_account

Description: A user that can be contacted, as an alternative to email.
Type: Account
Version history:
2.3.0 - added

rules

Description: An itemized list of rules for this website.
Type: Array of Rule
Version history:
3.4.0 - added

See also

GET /api/v1/instance
app/serializers/rest/v1/instance_serializer.rb

Last updated November 20, 2022 路 Improve this page

Sponsored by

Dotcom-Monitor LoadView Stephen Tures Swayable SponsorMotion

Join Mastodon 路 Blog 路 路

View source 路 CC BY-SA 4.0 路 Imprint