Merge branch 'stable' into develop
[akkoma] / docs / docs / development / API / nodeinfo.md
1 # Nodeinfo
2
3 See also [the Nodeinfo standard](https://nodeinfo.diaspora.software/).
4
5 ## `/.well-known/nodeinfo`
6 ### The well-known path
7 * Method: `GET`
8 * Authentication: not required
9 * Params: none
10 * Response: JSON
11 * Example response:
12 ```json
13 {
14 "links":[
15 {
16 "href":"https://example.com/nodeinfo/2.0.json",
17 "rel":"http://nodeinfo.diaspora.software/ns/schema/2.0"
18 },
19 {
20 "href":"https://example.com/nodeinfo/2.1.json",
21 "rel":"http://nodeinfo.diaspora.software/ns/schema/2.1"
22 }
23 ]
24 }
25 ```
26
27 ## `/nodeinfo/2.0.json`
28 ### Nodeinfo 2.0
29 * Method: `GET`
30 * Authentication: not required
31 * Params: none
32 * Response: JSON
33 * Example response:
34 ```json
35 {
36 "metadata":{
37 "accountActivationRequired":false,
38 "features":[
39 "pleroma_api",
40 "mastodon_api",
41 "mastodon_api_streaming",
42 "polls",
43 "pleroma_explicit_addressing",
44 "shareable_emoji_packs",
45 "multifetch",
46 "pleroma:api/v1/notifications:include_types_filter",
47 "relay",
48 "pleroma_emoji_reactions"
49 ],
50 "federation":{
51 "enabled":true,
52 "exclusions":false,
53 "mrf_hashtag":{
54 "federated_timeline_removal":[
55
56 ],
57 "reject":[
58
59 ],
60 "sensitive":[
61 "nsfw"
62 ]
63 },
64 "mrf_object_age":{
65 "actions":[
66 "delist",
67 "strip_followers"
68 ],
69 "threshold":604800
70 },
71 "mrf_policies":[
72 "ObjectAgePolicy",
73 "TagPolicy",
74 "HashtagPolicy"
75 ],
76 "quarantined_instances":[
77
78 ]
79 },
80 "fieldsLimits":{
81 "maxFields":10,
82 "maxRemoteFields":20,
83 "nameLength":512,
84 "valueLength":2048
85 },
86 "invitesEnabled":false,
87 "mailerEnabled":false,
88 "nodeDescription":"Pleroma: An efficient and flexible fediverse server",
89 "nodeName":"Example",
90 "pollLimits":{
91 "max_expiration":31536000,
92 "max_option_chars":200,
93 "max_options":20,
94 "min_expiration":0
95 },
96 "postFormats":[
97 "text/plain",
98 "text/html",
99 "text/markdown",
100 "text/bbcode"
101 ],
102 "private":false,
103 "restrictedNicknames":[
104 ".well-known",
105 "~",
106 "about",
107 "activities",
108 "api",
109 "auth",
110 "check_password",
111 "dev",
112 "friend-requests",
113 "inbox",
114 "internal",
115 "main",
116 "media",
117 "nodeinfo",
118 "notice",
119 "oauth",
120 "objects",
121 "ostatus_subscribe",
122 "pleroma",
123 "proxy",
124 "push",
125 "registration",
126 "relay",
127 "settings",
128 "status",
129 "tag",
130 "user-search",
131 "user_exists",
132 "users",
133 "web",
134 "verify_credentials",
135 "update_credentials",
136 "relationships",
137 "search",
138 "confirmation_resend",
139 "mfa"
140 ],
141 "skipThreadContainment":true,
142 "staffAccounts":[
143 "https://example.com/users/admin",
144 "https://example.com/users/staff"
145 ],
146 "suggestions":{
147 "enabled":false
148 },
149 "uploadLimits":{
150 "avatar":2000000,
151 "background":4000000,
152 "banner":4000000,
153 "general":16000000
154 }
155 },
156 "openRegistrations":true,
157 "protocols":[
158 "activitypub"
159 ],
160 "services":{
161 "inbound":[
162
163 ],
164 "outbound":[
165
166 ]
167 },
168 "software":{
169 "name":"pleroma",
170 "version":"2.4.1"
171 },
172 "usage":{
173 "localPosts":27,
174 "users":{
175 "activeHalfyear":129,
176 "activeMonth":70,
177 "total":235
178 }
179 },
180 "version":"2.0"
181 }
182 ```
183
184 ## `/nodeinfo/2.1.json`
185 ### Nodeinfo 2.1
186 * Method: `GET`
187 * Authentication: not required
188 * Params: none
189 * Response: JSON
190 * Example response:
191 ```json
192 {
193 "metadata":{
194 "accountActivationRequired":false,
195 "features":[
196 "pleroma_api",
197 "mastodon_api",
198 "mastodon_api_streaming",
199 "polls",
200 "pleroma_explicit_addressing",
201 "shareable_emoji_packs",
202 "multifetch",
203 "pleroma:api/v1/notifications:include_types_filter",
204 "relay",
205 "pleroma_emoji_reactions"
206 ],
207 "federation":{
208 "enabled":true,
209 "exclusions":false,
210 "mrf_hashtag":{
211 "federated_timeline_removal":[
212
213 ],
214 "reject":[
215
216 ],
217 "sensitive":[
218 "nsfw"
219 ]
220 },
221 "mrf_object_age":{
222 "actions":[
223 "delist",
224 "strip_followers"
225 ],
226 "threshold":604800
227 },
228 "mrf_policies":[
229 "ObjectAgePolicy",
230 "TagPolicy",
231 "HashtagPolicy"
232 ],
233 "quarantined_instances":[
234
235 ]
236 },
237 "fieldsLimits":{
238 "maxFields":10,
239 "maxRemoteFields":20,
240 "nameLength":512,
241 "valueLength":2048
242 },
243 "invitesEnabled":false,
244 "mailerEnabled":false,
245 "nodeDescription":"Pleroma: An efficient and flexible fediverse server",
246 "nodeName":"Example",
247 "pollLimits":{
248 "max_expiration":31536000,
249 "max_option_chars":200,
250 "max_options":20,
251 "min_expiration":0
252 },
253 "postFormats":[
254 "text/plain",
255 "text/html",
256 "text/markdown",
257 "text/bbcode"
258 ],
259 "private":false,
260 "restrictedNicknames":[
261 ".well-known",
262 "~",
263 "about",
264 "activities",
265 "api",
266 "auth",
267 "check_password",
268 "dev",
269 "friend-requests",
270 "inbox",
271 "internal",
272 "main",
273 "media",
274 "nodeinfo",
275 "notice",
276 "oauth",
277 "objects",
278 "ostatus_subscribe",
279 "pleroma",
280 "proxy",
281 "push",
282 "registration",
283 "relay",
284 "settings",
285 "status",
286 "tag",
287 "user-search",
288 "user_exists",
289 "users",
290 "web",
291 "verify_credentials",
292 "update_credentials",
293 "relationships",
294 "search",
295 "confirmation_resend",
296 "mfa"
297 ],
298 "skipThreadContainment":true,
299 "staffAccounts":[
300 "https://example.com/users/admin",
301 "https://example.com/users/staff"
302 ],
303 "suggestions":{
304 "enabled":false
305 },
306 "uploadLimits":{
307 "avatar":2000000,
308 "background":4000000,
309 "banner":4000000,
310 "general":16000000
311 }
312 },
313 "openRegistrations":true,
314 "protocols":[
315 "activitypub"
316 ],
317 "services":{
318 "inbound":[
319
320 ],
321 "outbound":[
322
323 ]
324 },
325 "software":{
326 "name":"pleroma",
327 "repository":"https://akkoma.dev/AkkomaGang/akkoma",
328 "version":"2.5.2"
329 },
330 "usage":{
331 "localPosts":27,
332 "users":{
333 "activeHalfyear":129,
334 "activeMonth":70,
335 "total":235
336 }
337 },
338 "version":"2.1"
339 }
340 ```
341