---
title: "Header Bidding API endpoints"
description: "Endpoint reference for the Header Bidding tag (9 endpoints): Header-bidding page tags: slots, refresh and Google Ad Manager settings, and the code a page carries"
type: "reference"
audience: [network-manager, admin]
keywords: [api, rest, endpoints, header, bidding]
---

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.

# Header Bidding API endpoints

Header-bidding page tags: slots, refresh and Google Ad Manager settings, and the code a page carries. 9 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/hb-tags.do

[Request examples](https://epom.com/ad-server/docs/api/header-bidding/get-hb-tags.md)

List header-bidding tags.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `siteId` | query | integer | no | Only the tags of this site |
| `limit` | query | integer | no | How many tags to return, 1-500 |

**Responses:** `200` — {data: [tag], total, more}. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### POST /rest-api/hb-tags.do

[Request examples](https://epom.com/ad-server/docs/api/header-bidding/post-hb-tags.md)

Create a header-bidding tag.

**Request body** (`application/json`, required): JSON object with fields `active`, `adServerWithoutConsent`, `allowZeroCpmBids`, `bidTimeoutMs`, `bidderCode`, `collapseEmpty`, `domain`, `id`, `integration`, `loadInViewOnly`, `name`, `ourDemandFirst`, `prebidGlobal`, `refreshForegroundOnly`, `refreshIdleMinutes`, `refreshInViewOnly`, `refreshSeconds`, `setDocumentLanguage`, `siteId`, `slots` — The tag.

**Responses:** `200` — {data: tag, code, ignoredFields, ignoredFieldReasons}. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### GET /rest-api/hb-tags/{tagId}.do

[Request examples](https://epom.com/ad-server/docs/api/header-bidding/get-hb-tags-by-tag-id.md)

Get a header-bidding tag by id.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `tagId` | path | integer | yes | Unique numeric ID of the tag |

**Responses:** `200` — {data: tag, code: {script, containers, gamKeys}} · `404` — Tag not found or deleted. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### POST /rest-api/hb-tags/{tagId}.do

[Request examples](https://epom.com/ad-server/docs/api/header-bidding/post-hb-tags-by-tag-id.md)

Update a header-bidding tag.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `tagId` | path | integer | yes | Unique numeric ID of the tag |

**Request body** (`application/json`, required): JSON object with fields `active`, `adServerWithoutConsent`, `allowZeroCpmBids`, `bidTimeoutMs`, `bidderCode`, `collapseEmpty`, `domain`, `id`, `integration`, `loadInViewOnly`, `name`, `ourDemandFirst`, `prebidGlobal`, `refreshForegroundOnly`, `refreshIdleMinutes`, `refreshInViewOnly`, `refreshSeconds`, `setDocumentLanguage`, `siteId`, `slots` — Only the fields to change.

**Responses:** `200` — {data: tag, code, ignoredFields, ignoredFieldReasons} · `404` — Tag not found or deleted. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### DELETE /rest-api/hb-tags/{tagId}.do

[Request examples](https://epom.com/ad-server/docs/api/header-bidding/delete-hb-tags.md)

Delete a header-bidding tag.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `tagId` | path | integer | yes | Unique numeric ID of the tag |

**Responses:** `200` — Deleted · `404` — Tag not found or deleted. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### GET /rest-api/hb-tags/ad-units.do

[Request examples](https://epom.com/ad-server/docs/api/header-bidding/get-hb-tags-ad-units.md)

List ad units (sizes) for header-bidding slots.

No parameters beyond authentication.

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

### GET /rest-api/hb-tags/bidders.do

[Request examples](https://epom.com/ad-server/docs/api/header-bidding/get-hb-tags-bidders.md)

List Prebid bidders a header-bidding slot can carry.

No parameters beyond authentication.

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

### GET /rest-api/hb-tags/domains.do

[Request examples](https://epom.com/ad-server/docs/api/header-bidding/get-hb-tags-domains.md)

List serving domains for header-bidding tags.

No parameters beyond authentication.

**Responses:** `200` — {data: [{domain, cdnDomain, isDefault}], total}. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### GET /rest-api/hb-tags/placements.do

[Request examples](https://epom.com/ad-server/docs/api/header-bidding/get-hb-tags-placements.md)

List placements a header-bidding slot can use.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `siteId` | query | integer | yes | Unique numeric ID of the site |

**Responses:** `200` — {data: [placement], total}. 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. -->