Browse the documentation

Header Bidding — `/openrtb2/cache`

Hosts: {rtb_domain} is your network's RTB domain, used by the bidder endpoints; a network without a dedicated RTB domain uses its ad domain there. {ad_domain} is the network's ad-serving domain. Inside the panel both are filled in for you.

Prebid Cache — stores winning VAST / native payloads server-side so the publisher can hand a tiny UUID to the ad server instead of inlining the whole creative. Prebid.js calls this automatically when cacheConfig is set.

Put#

POST a puts array with the payloads to cache. Returns one UUID per payload, in input order. Default TTL 5 minutes; set ttlseconds per put to override (max 1 hour).

Request

{
  "puts": [{
    "type":       "xml",
    "value":      "<VAST version=\"3.0\">…</VAST>",
    "ttlseconds": 300
  }]
}

Response

{
  "responses": [
    { "uuid": "abc-123-def-456" }
  ]
}

Get#

GET ?uuid={uuid} — returns the cached payload as the original content type. Used by ad servers fetching the cached VAST / native.

URL

GET https://{ad_domain}/openrtb2/cache?uuid={uuid}