3628b6d434
* add rules * join date on profiles * deprecate follow scope * deprecate identity proofs * familiar followers * use definition lists instead of tables for defining activitypub properties * reformat notifications page into markdown * fix broken links to publicKey header * Application website is now nullable * update environment variables added and removed * fix typo * fix heading level * min_id and max_id can be used at the same time (3.3) * fix typo * new tootctl options * reformat tootctl page to use definition lists for params * add rules and configuration to Instance * fix typo * refactor instance api page * 3.3.0 duration on mutes * 3.3.0 mute_expires_at * improve section headings * 3.4.0 resend email confirmation api * 3.4.0 policy on push subscriptions * 3.4.0 add details to account registration error * refactor accounts api page and start adding relrefs to entity pages * 3.4.0 accounts/lookup api * add see also to accounts methods * add more see-also links * 3.5.0 appeal mod decisions * 3.5.0 reformat reports and add category/rule_ids params * document report entity and missing responses * fix typos * fix relrefs and url schema, add aliases to old urls * add archetypes for new methods/entities * update archetypes with see-also stubs * clearer presentation of rate limits * announcements api methods * refactor apps methods * refactor bookmarks methods + some anchors * refactor conversations methods * custom_emojis methods refactor * anchors * refactor directory methods * refactor domain_blocks methods * add see also to emails methods * fix page relref shortcodes to specific methods + refactor endorsements methods * min_id max_id * refactor favourites methods * refactor featured_tags methods * refactor filters methods, make path params consistent, i18n required shortcode * follow_requests methods * lists methods * markers methods * forgot to add entity links * media methods, also fix formatting of some json errors * mutes methods, add more see-also links * oembed methods * preferences methods * proofs methods * push methods * suggestions methods * 3.5.0 add new trend types, fix formatting * refactor streaming methods * refactor oauth methods * note that streaming api casts payload to string * refactor search methods * refactor polls methods * remove unnecessary link * reformat scheduled_statuses methods * reformat timelines methods * reformat statuses methods * 3.5.0 editing statuses * consistent use of array brackets in form data parameters * update dev setup guide, add vagrant and clean up text * add admin/accounts methods * 3.6 role entity * admin/accounts methods v2 * minor fix * stub admin/reports methods * document admin reports * add 403 example to methods archetype * cleanup entities for admin reports and add new attrs * 3.6.0 domain allows methods + normalize admin entity namespace * fix search-and-replace error * add aliases for admin entities * 3.6.0 canonical email blocks entity * 3.5.0 admin/retention api * 3.5.0 add admin::ip doc * 3.5.0 admin/reports * 3.6.0 admin/domain_allows * 3.5.0 admin/dimensions * 3.6.0 permissions and roles * minor formatting fix * add anchor link to headings * checkpoint * add update commands to dev env setup guide * change mentions of v3.6 to v4.0 * tootctl now uses custom roles * fix formatting * v2 instance api * update frontmatter, add better titles to pages * minor wording change * consistency * add more aliases * add placeholders and WIP notices * explain link pagination and stub out todos * switch baseURL to https * 422 on reports with rules but category!=violation * document bug fixes * fix typo * remove duplicate API method definition * s/tootsuite/mastodon for github links * remove unnecessary escaping * s/tootsuite/mastodon in Entity archetype * add missing nullable shortcode * clarify oauth scope when requesting a user token * api/v2/media now synchronous for images * DISALLOW_UNAUTHENTICATED_API_ACCESS * add undocumented env variables * add instance domain blocks and extended description api * add SMTP_ENABLE_STARTTLS * add description to SMTP_ENABLE_STARTTLS * take suggestions from open PRs * normalize links and flavour language * Fully document streaming API based on source code * Add mention of MIME types * bump to ruby 3.0.4 * clarify how to check on async media processing * validation of replies_policy * remove TODOs on admin account action * EmailDomainBlocks * IpBlocks * Admin::DomainBlock * remove TODOs * following hashtags * followed_tags * remove reference to unused parameter * add new oauth scopes for admin blocks and allows * fix command signature for i18n-tasks normalize * reformat code structure page * document fixes for following tags (assume 4.0.3) * Add warning about pre-4.0 hardcoded roles * add note about case sensitivity * remove use of 'simply' from docs * remove reference to silencing * add reference to IDN normalization for verified links * add lang parameter
11 KiB
| title | description | menu | aliases | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| V1::Instance | Represents the software instance of Mastodon running on this domain. |
|
|
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: {{}} 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]({{< relref "entities/Account" >}})
Version history:
2.3.0 - added
rules
Description: An itemized list of rules for this website.
Type: Array of [Rule]({{< relref "entities/Rule" >}})
Version history:
3.4.0 - added
See also
{{< page-relref ref="methods/instance#v1" caption="GET /api/v1/instance" >}}
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/v1/instance_serializer.rb" caption="app/serializers/rest/v1/instance_serializer.rb" >}}