Ad InsertionConfigure Ad Server

Configure Ad Server

Custom Plan Sets the upstream VAST/VMAP ad server URL, query parameters, and custom origin headers. Selecting the avails.5centscdn.com-vmap template unlocks and enforces the Schedules feature.

curl -X POST "https://api.5centscdn.com/v2/zones/vod/push/42/adinsertion/server" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "template": "avails.5centscdn.com-vmap",
  "url": "https://avails.5centscdn.com/v1/vmap",
  "queryParameters": [
    {
      "name": "publisher_id",
      "type": "custom",
      "value": "8f2a1c3e-4b5d-4a6e-9f1a-2b3c4d5e6f7a"
    }
  ],
  "adOrigin": {
    "customHeaders": []
  }
}'
{
  "statusCode": 200,
  "id": 36,
  "tenantId": 103,
  "type": "ad-server",
  "name": "5-103-push-5611-adserver",
  "url": "https://avails.5centscdn.com/v1/vmap",
  "template": "avails.5centscdn.com-vmap",
  "queryParameters": [
    {
      "name": "publisher_id",
      "type": "custom",
      "value": "8f2a1c3e-4b5d-4a6e-9f1a-2b3c4d5e6f7a"
    }
  ],
  "adOrigin": {
    "customHeaders": [
      {
        "name": "X-Api-Key",
        "value": "Bearer abc123"
      }
    ]
  },
  "result": "success"
}
POST
/zones/vod/push/{zoneid}/adinsertion/server
POST
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: X-API-Key)
X-API-Keystring
Required

API key (sent in header)

Content-Typestring
Required

The media type of the request body

Options: application/json
templatestring

Ad server integration template. avails.5centscdn.com-vmap unlocks and enforces the Schedules feature; generic does not.

Options: generic, avails.5centscdn.com-vmap
urlstring
Required

The VAST or VMAP ad server endpoint URL.

Format: uri
queryParametersarray

A dynamic list of query parameters appended to every ad server request.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-API-Keystring
Required

API Key for authentication. Provide your API key in the header.

Path Parameters

zoneidinteger
Required

Zone ID

Example:
42

Body

application/json
templatestring

Ad server integration template. avails.5centscdn.com-vmap unlocks and enforces the Schedules feature; generic does not.

Allowed values:genericavails.5centscdn.com-vmap
urlstring
Required

The VAST or VMAP ad server endpoint URL.

Example:
https://avails.5centscdn.com/v1/vmap
queryParametersarray

A dynamic list of query parameters appended to every ad server request.

adOriginobject

Responses

statusCodeinteger
idinteger
tenantIdinteger
typestring
namestring
urlstring
templatestring
queryParametersarray
adOriginobject
resultstring
Allowed values:successerror