diff options
| author | Eugen Rochko <eugen@zeonfederated.com> | 2017-03-15 23:12:48 +0100 |
|---|---|---|
| committer | Eugen Rochko <eugen@zeonfederated.com> | 2017-03-15 23:12:48 +0100 |
| commit | 6be7bde24378bcb034552248021ea2450bb10524 (patch) | |
| tree | 99af4a2c5355dc7ad3fa39ed828332db24bda799 /docs/Using-the-API | |
| parent | 7b58c1a694eed95e367cc8d078f91c390dffec4d (diff) | |
Fix #525 - Add instance information API
Diffstat (limited to 'docs/Using-the-API')
| -rw-r--r-- | docs/Using-the-API/API.md | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/docs/Using-the-API/API.md b/docs/Using-the-API/API.md index 2c323d559..4db634a60 100644 --- a/docs/Using-the-API/API.md +++ b/docs/Using-the-API/API.md @@ -19,7 +19,7 @@ API overview - Who reblogged/favourited a status - Following/unfollowing accounts - Blocking/unblocking accounts - - Getting site information + - Getting instance information - Creating OAuth apps - [Entities](#entities) - Status @@ -227,12 +227,11 @@ Returns the updated relationship to the user. Returns the updated relationship to the user. -### Getting site information +### Getting instance information -**GET /api/v1/site** +**GET /api/v1/instance** -Returns an object containing the `title`, character limit (`max_chars`), and an object of `links` for the site. -Does not require authentication. +Returns an object containing the `title`, `description`, `email` and `uri` of the instance. Does not require authentication. # Muting and unmuting users |