Skip to content

AdminBrandImage

A brand image as the administrators see it: the image of Instance with the background color of the icon and when it was set, and, in the answer to setAdminBrand, what the sanitizer removed from the upload.

object
revision
required
string
svg_url
required
string format: uri
width
required

The width of the SVG’s viewBox, rounded.

integer
>= 1
height
required

The height of the SVG’s viewBox, rounded.

integer
>= 1
renditions
required
Array<object>

A PNG rendition of a brand image, served at a URL whose content never changes.

object
rendition
required

A PNG rendition of a brand image, drawn from its SVG for the places that take no SVG: favicon-32 and favicon-48 (32 and 48 pixels), apple-touch-180 (180 pixels, opaque, the iOS home screen), pwa-192 and pwa-512 (the app icons), and maskable-512 (512 pixels, opaque, the mark within the middle 80%) of the icon; logo-mail of the logo and logo-dark-mail of the dark logo (96 pixels high and as wide as the aspect ratio makes it, up to 600 pixels, which then sets the height; a pixel off is accepted), shown in emails; and preview-1200x630 of the logo (1200 × 630 pixels, opaque), the link preview image when the instance has no preview_image.

string
Allowed values: favicon-32 favicon-48 apple-touch-180 pwa-192 pwa-512 maskable-512 logo-mail logo-dark-mail preview-1200x630
url
required
string format: uri
width
required
integer
>= 1
height
required
integer
>= 1
background

The #rrggbb color behind the opaque renditions of the icon; omitted for a logo.

string
/^#[0-9a-f]{6}$/
revised_at
required
string format: date-time
dropped
Array<object>

Something the server removed from an uploaded SVG: an element with everything in it, or an attribute, by its local name.

object
kind
required
string
Allowed values: element attribute
name
required
string

Example generated

{
"revision": "example",
"svg_url": "https://example.com",
"width": 1,
"height": 1,
"renditions": [
{
"rendition": "favicon-32",
"url": "https://example.com",
"width": 1,
"height": 1
}
],
"background": "example",
"revised_at": "2026-04-15T12:00:00Z",
"dropped": [
{
"kind": "element",
"name": "example"
}
]
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site