2020-01-01 22:37:59 +01:00
---
title: Instance
description: Represents the software instance of Mastodon running on this domain.
menu:
docs:
parent: entities
---
## Example
```javascript
"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",
2020-01-12 14:11:56 +01:00
"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}",
2020-01-01 22:37:59 +01:00
"verified_at": null
},
{
"name": "Homepage",
2020-01-12 14:11:56 +01:00
"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}",
2020-01-01 22:37:59 +01:00
"verified_at": "2019-07-15T18:29:57.191+00:00"
}
]
}
}
```
## Required attributes
2020-01-12 14:11:56 +01:00
### `uri` {#uri}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** The domain name of the instance.\
**Type:** String\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 1.1.0
2020-01-12 14:11:56 +01:00
### `title` {#title}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** The title of the website.\
**Type:** String\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 1.1.0
2020-01-12 14:11:56 +01:00
### `description` {#description}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** Admin-defined description of the Mastodon site.\
**Type:** String\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 1.1.0
2020-01-12 14:11:56 +01:00
### `short_description` {#short_description}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** A shorter description defined by the admin.\
**Type:** String\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 2.9.2
2020-01-12 14:11:56 +01:00
### `email` {#email}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** An email that may be contacted for any inquiries.\
**Type:** String\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 1.1.0
2020-01-12 14:11:56 +01:00
### `version` {#version}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** The version of Mastodon installed on the instance.\
**Type:** String\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 1.3.0
2020-01-12 14:11:56 +01:00
### `languages` {#languages}
2020-01-01 22:37:59 +01:00
2022-03-12 19:33:34 +01:00
**Description:** Primary languages of the website and its staff.\
2020-01-12 14:11:56 +01:00
**Type:** Array of String \(ISO 639 Part 1-5 language codes\)\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 2.3.0
2020-01-12 14:11:56 +01:00
### `registrations` {#registrations}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** Whether registrations are enabled.\
**Type:** Boolean\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 2.7.2
2020-01-12 14:11:56 +01:00
### `approval_required` {#approval_required}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** Whether registrations require moderator approval.\
**Type:** Boolean\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 2.9.2
2020-07-01 03:13:20 +02:00
### `invites_enabled` {#invites_enabled}
**Description:** Whether invites are enabled.\
**Type:** Boolean\
**Version history:** Added in 3.1.4
2020-01-12 14:11:56 +01:00
### `urls` {#urls}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** URLs of interest for clients apps.\
**Type:** Hash \(`streaming_api` \)\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 1.4.2
2020-01-12 14:11:56 +01:00
#### `urls[streaming_api]` {#streaming_api}
2020-01-01 22:37:59 +01:00
Websockets address for push streaming. String \(URL\).
2020-01-12 14:11:56 +01:00
### `stats` {#stats}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** Statistics about how much information the instance contains.\
**Type:** Hash \(`user_count` , `status_count` , `domain_count` \)\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 1.6.0
2020-01-12 14:11:56 +01:00
#### `user_count` {#user_count}
2020-01-01 22:37:59 +01:00
Users registered on this instance. Number.
2020-01-12 14:11:56 +01:00
#### `status_count` {#status_count}
2020-01-01 22:37:59 +01:00
Statuses authored by users on instance. Number.
2020-01-12 14:11:56 +01:00
#### `domain_count` {#domain_count}
2020-01-01 22:37:59 +01:00
Domains federated with this instance. Number.
## Optional attributes
2020-01-12 14:11:56 +01:00
### `thumbnail` {#thumbnail}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** Banner image for the website.\
**Type:** String \(URL\) or null\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 1.6.1
2020-01-12 14:11:56 +01:00
### `contact_account` {#contact_account}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** A user that can be contacted, as an alternative to `email` .\
2020-08-10 23:01:50 +02:00
**Type:** [Account ]({{< relref "account.md" >}} ) or null\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 2.3.0
## See also
{{< page-ref page = "methods/instance.md" > }}
{{< caption-link url = "https://github.com/tootsuite/mastodon/blob/master/app/serializers/rest/instance_serializer.rb" caption = "app/serializers/rest/instance \_serializer.rb" > }}