---
title: "White Label API endpoints"
description: "Endpoint reference for the White Label tag (6 endpoints): Administrators only: network branding — the interface theme and the images the platform is served with. Needs the White Label console permission"
type: "reference"
audience: [network-manager, admin]
keywords: [api, rest, endpoints, white, label, account, users, admin]
---

Fetch the complete documentation index at: https://epom.com/ad-server/docs/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.

# White Label API endpoints

Administrators only: network branding — the interface theme and the images the platform is served with. Needs the White Label console permission. 6 endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see [REST API overview](https://epom.com/ad-server/docs/api.md). Parameters marked `form` go in an `application/x-www-form-urlencoded` request body.

### GET /rest-api/white-label/brand-images.do

[Request examples](https://epom.com/ad-server/docs/api/white-label/get-white-label-brand-images.md)

The limits a brand pack is read under.

No parameters beyond authentication.

**Responses:** `200` — {maxArchiveMb, maxPageMb, maxImageMb, maxTotalMb, maxImages, pdf} — maxPageMb is how much of a page's markup is scanned. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### POST /rest-api/white-label/brand-images.do

[Request examples](https://epom.com/ad-server/docs/api/white-label/post-white-label-brand-images.md)

Read the candidate images out of a brand pack.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `url` | form | string | no | A public http(s) link to the brand's page, or to one image or ZIP |

**Request body** (`multipart/form-data`): form with field `file` — A ZIP of the brand's image files, or one image file; up to 20 MB.

**Responses:** `200` — {images: [{name, contentType, origin, bytes}], total, more, source: {kind, origin}}. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### GET /rest-api/white-label/brand-palette.do

[Request examples](https://epom.com/ad-server/docs/api/white-label/get-white-label-brand-palette.md)

Whether a brand's colours can be read for the theme.

No parameters beyond authentication.

**Responses:** `200` — {available, reason, maxPdfMb, maxImageMb, maxPageMb, maxTextLength}. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### POST /rest-api/white-label/brand-palette.do

[Request examples](https://epom.com/ad-server/docs/api/white-label/post-white-label-brand-palette.md)

Read a brand's colours for the theme editor.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `url` | form | string | no | A public http(s) link to the brand's page or its guideline PDF |
| `text` | form | string | no | The brand's name, or the text of its guideline; up to 150,000 characters are read |

**Request body** (`multipart/form-data`): form with field `file` — The brand's guideline as a file: a PDF (up to 20 MB), a PNG, JPEG, GIF or WEBP image (up to 5 MB), or a text or HTML file (up to 2 MB).

**Responses:** `200` — {brands: [{brand, source, notes, readBy, colors: [{hex, role, name}]}], total, more, document: {kind, origin}} · `429` — This month's AI budget is spent · `503` — No Anthropic key is set up, or the model could not be reached or answered something that cannot be read; try again. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### GET /rest-api/white-label/login-background.do

[Request examples](https://epom.com/ad-server/docs/api/white-label/get-white-label-login-background.md)

Whether a sign-in background can be drawn.

No parameters beyond authentication.

**Responses:** `200` — {available, reason, styles, maxNoteLength, maxColors}. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### POST /rest-api/white-label/login-background.do

[Request examples](https://epom.com/ad-server/docs/api/white-label/post-white-label-login-background.md)

Draw a sign-in background from a network's colours.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `style` | form | string | no | The starting point: GRADIENT (colours blended across the frame), SHAPES (large soft overlapping shapes), GEOMETRY (a low-contrast repeating pattern) or GRAIN (a fine texture over a plain ground) |
| `colors` | form | array&lt;string&gt; | no | The network's colours as #rrggbb, the accent first; at most 8 are used and anything that is not a colour is left out |
| `note` | form | string | no | One line of the operator's own on what it should feel like |

**Responses:** `200` — {svg, style} · `429` — This month's AI budget is spent · `503` — No Anthropic key is set up, or the model could not be reached, declined, or answered something that is not a drawing; try again. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

## Related

- [REST API overview](https://epom.com/ad-server/docs/api.md) — authentication and conventions
- [API endpoint reference by tag](https://epom.com/ad-server/docs/api/endpoints.md)

<!-- Generated from the OpenAPI spec. Do not edit by hand. -->