-
Notifications
You must be signed in to change notification settings - Fork 45
Favicon API
Marius David Wieschollek edited this page Feb 4, 2024
·
1 revision
The favicon endpoint returns a png favicon icon for the given domain.
[[TOC]]
| App Version | Change |
|---|---|
| 2018.1.0 | Initial introduction of the API |
| Path | Method | Session required |
|---|---|---|
/api/1.0/service/favicon/{domain}/{size} |
GET | no |
| Arguments | Type | Default | Required | Description |
|---|---|---|---|---|
| domain | string | - | yes | The domain name |
| size | int | 32 | no | The size of the favicon in pixels. I must be a multiple of 8 and between 16 and 256. |
- Nextcloud Authentication required
The success status code is 200 Ok.
This action returns a png image file on success
| Status | MIME | Description |
|---|---|---|
| 200 | image/png | The avatar image file |
| 500 | text/html | Error page |
| 502 | text/html | Error page |
- If no favicon can be found, a default image will be generated
- Favicons rarely change and can be cached for a long time