Update content for 4.0 (part 1) (#991)
* 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
This commit is contained in:
trwnh
GitHub
parent
69e9017730
commit
3628b6d434
225 changed files with 22675 additions and 11631 deletions
|
|
@ -1,96 +1,195 @@
|
|||
---
|
||||
title: instance
|
||||
description: Informational endpoint to discover information about a Mastodon website.
|
||||
title: instance API methods
|
||||
description: Discover information about a Mastodon website.
|
||||
menu:
|
||||
docs:
|
||||
weight: 70
|
||||
name: instance
|
||||
parent: methods
|
||||
identifier: methods-instance
|
||||
aliases: [
|
||||
"/methods/instance",
|
||||
"/api/methods/instance",
|
||||
]
|
||||
---
|
||||
|
||||
{{< api-method method="get" host="https://mastodon.example" path="/api/v1/instance" title="Fetch instance" >}}
|
||||
{{< api-method-description >}}
|
||||
<style>
|
||||
#TableOfContents ul ul ul {display: none}
|
||||
</style>
|
||||
|
||||
Information about the server.
|
||||
## View server information {#v2}
|
||||
|
||||
**Returns:** Instance\
|
||||
```http
|
||||
GET https://mastodon.example/api/v2/instance
|
||||
```
|
||||
|
||||
Obtain general information about the server.
|
||||
|
||||
**Returns:** [V1::Instance]({{< relref "entities/instance" >}})\
|
||||
**OAuth:** Public\
|
||||
**Version history:**\
|
||||
1.1.0 - added\
|
||||
3.0.0 - requires user token if instance is in whitelist mode\
|
||||
3.1.4 - added `invites_enabled` to response
|
||||
4.0.0 - added
|
||||
|
||||
{{< endapi-method-description >}}
|
||||
{{< api-method-spec >}}
|
||||
{{< api-method-request >}}
|
||||
{{< api-method-response >}}
|
||||
{{< api-method-response-example httpCode=200 >}}
|
||||
{{< api-method-response-example-description >}}
|
||||
{{< endapi-method-response-example-description >}}
|
||||
#### Response
|
||||
|
||||
##### 200: OK
|
||||
|
||||
```javascript
|
||||
|
||||
"uri": "mastodon.social",
|
||||
```json
|
||||
{
|
||||
"domain": "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"
|
||||
"version": "4.0.0rc1",
|
||||
"source_url": "https://github.com/mastodon/mastodon",
|
||||
"description": "The original server operated by the Mastodon gGmbH non-profit",
|
||||
"usage": {
|
||||
"users": {
|
||||
"active_month": 123122
|
||||
}
|
||||
},
|
||||
"stats": {
|
||||
"user_count": 415526,
|
||||
"status_count": 17085754,
|
||||
"domain_count": 11834
|
||||
"thumbnail": {
|
||||
"url": "https://files.mastodon.social/site_uploads/files/000/000/001/@1x/57c12f441d083cde.png",
|
||||
"blurhash": "UeKUpFxuo~R%0nW;WCnhF6RjaJt757oJodS$",
|
||||
"versions": {
|
||||
"@1x": "https://files.mastodon.social/site_uploads/files/000/000/001/@1x/57c12f441d083cde.png",
|
||||
"@2x": "https://files.mastodon.social/site_uploads/files/000/000/001/@2x/57c12f441d083cde.png"
|
||||
}
|
||||
},
|
||||
"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></a>",
|
||||
"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></a>",
|
||||
"verified_at": "2019-07-15T18:29:57.191+00:00"
|
||||
}
|
||||
]
|
||||
}
|
||||
"configuration": {
|
||||
"urls": {
|
||||
"streaming": "wss://mastodon.social"
|
||||
},
|
||||
"accounts": {
|
||||
"max_featured_tags": 10
|
||||
},
|
||||
"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/heic",
|
||||
"image/heif",
|
||||
"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
|
||||
},
|
||||
"translation": {
|
||||
"enabled": true
|
||||
}
|
||||
},
|
||||
"registrations": {
|
||||
"enabled": false,
|
||||
"approval_required": false,
|
||||
"message": null
|
||||
},
|
||||
"contact": {
|
||||
"email": "staff@mastodon.social",
|
||||
"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": "<p>Founder, CEO and lead developer <span class=\"h-card\"><a href=\"https://mastodon.social/@Mastodon\" class=\"u-url mention\">@<span>Mastodon</span></a></span>, Germany.</p>",
|
||||
"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": 133026,
|
||||
"following_count": 311,
|
||||
"statuses_count": 72605,
|
||||
"last_status_at": "2022-10-31",
|
||||
"noindex": false,
|
||||
"emojis": [],
|
||||
"fields": [
|
||||
{
|
||||
"name": "Patreon",
|
||||
"value": "<a href=\"https://www.patreon.com/mastodon\" target=\"_blank\" rel=\"nofollow noopener noreferrer me\"><span class=\"invisible\">https://www.</span><span class=\"\">patreon.com/mastodon</span><span class=\"invisible\"></span></a>",
|
||||
"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"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{{< endapi-method-response-example >}}
|
||||
{{< endapi-method-response >}}
|
||||
{{< endapi-method-spec >}}
|
||||
{{< endapi-method >}}
|
||||
{{< api-method method="get" host="https://mastodon.example" path="/api/v1/instance/peers" title="List of connected domains" >}}
|
||||
{{< api-method-description >}}
|
||||
|
||||
|
||||
---
|
||||
|
||||
## List of connected domains {#peers}
|
||||
|
||||
```http
|
||||
GET https://mastodon.example/api/v1/instance/peers HTTP/1.1
|
||||
```
|
||||
|
||||
Domains that this instance is aware of.
|
||||
|
||||
|
|
@ -100,43 +199,72 @@ Domains that this instance is aware of.
|
|||
2.1.2 - added\
|
||||
3.0.0 - requires user token if instance is in whitelist mode
|
||||
|
||||
{{< endapi-method-description >}}
|
||||
{{< api-method-spec >}}
|
||||
{{< api-method-request >}}
|
||||
{{< api-method-response >}}
|
||||
{{< api-method-response-example httpCode=200 >}}
|
||||
{{< api-method-response-example-description >}}
|
||||
{{< endapi-method-response-example-description >}}
|
||||
#### Request
|
||||
|
||||
##### Headers
|
||||
|
||||
```javascript
|
||||
Authorization
|
||||
: Provide this header with `Bearer <user token>` to gain authorized access to this API method.
|
||||
|
||||
#### Response
|
||||
|
||||
##### 200: OK
|
||||
|
||||
```json
|
||||
["tilde.zone","mspsocial.net",...,"conf.tube"]
|
||||
```
|
||||
{{< endapi-method-response-example >}}
|
||||
{{< endapi-method-response >}}
|
||||
{{< endapi-method-spec >}}
|
||||
{{< endapi-method >}}
|
||||
{{< api-method method="get" host="https://mastodon.example" path="/api/v1/instance/activity" title="Weekly activity" >}}
|
||||
{{< api-method-description >}}
|
||||
|
||||
##### 401: Unauthorized
|
||||
|
||||
If the instance is in whitelist mode and the Authorization header is missing or invalid
|
||||
|
||||
```json
|
||||
{
|
||||
"error": "This API requires an authenticated user"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Weekly activity {#activity}
|
||||
|
||||
```http
|
||||
GET https://mastodon.example/api/v1/instance/activity HTTP/1.1
|
||||
```
|
||||
|
||||
Instance activity over the last 3 months, binned weekly.
|
||||
|
||||
**Returns:** Array of Activity\
|
||||
**Returns:** Array of Hash\
|
||||
**OAuth:** Public\
|
||||
**Version history:**\
|
||||
2.1.2 - added\
|
||||
3.0.0 - requires user token if instance is in whitelist mode
|
||||
|
||||
{{< endapi-method-description >}}
|
||||
{{< api-method-spec >}}
|
||||
{{< api-method-request >}}
|
||||
{{< api-method-response >}}
|
||||
{{< api-method-response-example httpCode=200 >}}
|
||||
{{< api-method-response-example-description >}}
|
||||
{{< endapi-method-response-example-description >}}
|
||||
#### Request
|
||||
|
||||
##### Headers
|
||||
|
||||
```
|
||||
Authorization
|
||||
: Provide this header with `Bearer <user token>` to gain authorized access to this API method.
|
||||
|
||||
#### Response
|
||||
##### 200: OK
|
||||
|
||||
Each hash in the array will contain the following attributes:
|
||||
|
||||
week
|
||||
: String (UNIX Timestamp). Midnight at the first day of the week.
|
||||
|
||||
statuses
|
||||
: String (cast from an integer). The number of Statuses created since the week began.
|
||||
|
||||
logins
|
||||
: String (cast from an integer). The number of user logins since the week began.
|
||||
|
||||
registrations
|
||||
: String (cast from an integer). The number of user registrations since the week began.
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"week": "1574640000",
|
||||
|
|
@ -212,9 +340,314 @@ Instance activity over the last 3 months, binned weekly.
|
|||
}
|
||||
]
|
||||
```
|
||||
{{< endapi-method-response-example >}}
|
||||
{{< endapi-method-response >}}
|
||||
{{< endapi-method-spec >}}
|
||||
{{< endapi-method >}}
|
||||
|
||||
##### 401: Unauthorized
|
||||
|
||||
If the instance is in whitelist mode and the Authorization header is missing or invalid
|
||||
|
||||
```json
|
||||
{
|
||||
"error": "This API requires an authenticated user"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## List of rules {#rules}
|
||||
|
||||
|
||||
```http
|
||||
GET https://mastodon.example/api/v1/instance/rules HTTP/1.1
|
||||
```
|
||||
|
||||
Rules that the users of this service should follow.
|
||||
|
||||
**Returns:** Array of [Rule]({{< relref "entities/rule" >}})\
|
||||
**OAuth:** Public\
|
||||
**Version history:**\
|
||||
3.4.0 - added
|
||||
|
||||
#### Response
|
||||
##### 200: OK
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"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"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## View moderated servers {#domain_blocks}
|
||||
|
||||
```http
|
||||
GET https://mastodon.example/api/v1/instance/domain_block HTTP/1.1
|
||||
```
|
||||
|
||||
Obtain a list of domains that have been blocked.
|
||||
|
||||
**Returns:** Array of [DomainBlock]({{< relref "entities/DomainBlock" >}})\
|
||||
**OAuth:** Public, or User token if limited to users\
|
||||
**Version history:**\
|
||||
4.0.0 - added
|
||||
|
||||
#### Request
|
||||
|
||||
##### Headers
|
||||
|
||||
Authorization
|
||||
: Provide this header with `Bearer <user token>` to gain authorized access to this API method.
|
||||
|
||||
#### Response
|
||||
##### 200: OK
|
||||
|
||||
The complete list of domains blocked by this instance
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"domain":"birb.elfenban.de",
|
||||
"digest":"5d2c6e02a0cced8fb05f32626437e3d23096480b47efbba659b6d9e80c85d280",
|
||||
"severity":"suspend",
|
||||
"comment":"Third-party bots"
|
||||
},
|
||||
{
|
||||
"domain":"birdbots.leptonics.com",
|
||||
"digest":"ce019d8d32cce8e369ac4367f4dc232103e6f489fbdd247fb99f9c8a646078a4",
|
||||
"severity":"suspend",
|
||||
"comment":"Third-party bots"
|
||||
},
|
||||
// ...
|
||||
]
|
||||
```
|
||||
|
||||
##### 401: Unauthorized
|
||||
|
||||
Invalid or missing Authorization header, if the admin has chosen to show domain blocks to users.
|
||||
|
||||
```json
|
||||
{
|
||||
"error": "The access token is invalid"
|
||||
}
|
||||
```
|
||||
|
||||
##### 404: Not found
|
||||
|
||||
The admin has chosen to show domain blocks to no one. The response body is empty; only the HTTP 404 error code is relevant.
|
||||
|
||||
```text
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## View extended description {#extended_description}
|
||||
|
||||
```http
|
||||
GET https://mastodon.example/api/v1/example HTTP/1.1
|
||||
```
|
||||
|
||||
Obtain an extended description of this server
|
||||
|
||||
**Returns:** [ExtendedDescription]({{< relref "entities/ExtendedDescription" >}})\
|
||||
**OAuth:** Public\
|
||||
**Version history:**\
|
||||
4.0.0 - added
|
||||
|
||||
#### Response
|
||||
##### 200: OK
|
||||
|
||||
```json
|
||||
{
|
||||
"updated_at":"2022-11-03T04:09:07Z",
|
||||
"content":"<p>For inquiries not related specifically to the operation of this server, such as press inquiries, please contact <a href=\"mailto:press@joinmastodon.org\">press@joinmastodon.org</a>.</p>\n\n<h2>Funding</h2>\n\n<p>This server is crowdfunded by <a href=\"https://patreon.com/mastodon\">Patreon donations</a>. For a list of sponsors, see <a href=\"https://joinmastodon.org/sponsors\">joinmastodon.org</a>.</p>\n\n<h2>Reporting and moderation</h2>\n\n<p>When reporting accounts, please make sure to include at least a few posts that show rule-breaking behaviour, when applicable. If there is any additional context that might help make a decision, please also include it in the comment. This is especially important when the content is in a language nobody on the moderation team speaks.</p>\n\n<p>We usually handle reports within 24 hours. Please mind that you are not notified when a report you have made has led to a punitive action, and that not all punitive actions are externally visible. For first time offenses, we may opt to delete offending content, escalating to harsher measures on repeat offenses.</p>\n\n<h2>Impressum</h2>\n\n<p>Mastodon gGmbH<br>\nMühlenstraße 8a<br>\n14167 Berlin<br>\nGermany</p>\n\n<p>E-Mail-Adresse: hello@joinmastodon.org</p>\n\n<p>Vertretungsberechtigt: Eugen Rochko (Geschäftsführer)</p>\n\n<p>Umsatzsteuer Identifikationsnummer (USt-ID): DE344258260</p>\n\n<p>Handelsregister<br>\nGeführt bei: Amtsgericht Charlottenburg<br>\nNummer: HRB 230086 B</p>\n"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## (DEPRECATED) View server information (V1) {#v1}
|
||||
|
||||
```http
|
||||
GET https://mastodon.example/api/v1/instance HTTP/1.1
|
||||
```
|
||||
|
||||
Obtain general information about the server.
|
||||
|
||||
**Returns:** [V1::Instance]({{< relref "entities/instance" >}})\
|
||||
**OAuth:** Public\
|
||||
**Version history:**\
|
||||
1.1.0 - added\
|
||||
3.0.0 - requires user token if instance is in whitelist mode\
|
||||
3.1.4 - added `invites_enabled` to response\
|
||||
3.4.0 - added `rules`\
|
||||
3.4.2 - added `configuration`\
|
||||
4.0.0 - deprecated. added `configuration[accounts]`.
|
||||
|
||||
#### Response
|
||||
|
||||
##### 200: OK
|
||||
|
||||
```json
|
||||
{
|
||||
"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"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## See also
|
||||
|
||||
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/instances_controller.rb" caption="app/controllers/api/v1/instances_controller.rb" >}}
|
||||
|
||||
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/instances/activity_controller.rb" caption="app/controllers/api/v1/instances/activity_controller.rb" >}}
|
||||
|
||||
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/instances/peers_controller.rb" caption="app/controllers/api/v1/instances/peers_controller.rb" >}}
|
||||
|
||||
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/instances/rules_controller.rb" caption="app/controllers/api/v1/instances/rules_controller.rb" >}}
|
||||
Loading…
Add table
Add a link
Reference in a new issue