Documentation Center

Viz Channel Branding User Guide

Version 5.1 | Published October 26, 2023 ©

GET API Root

The starting point for the structure of the REST API is found by calling the address and ip for the service. The port for Promo Server REST API is by default 9980.

Example request using curl against the service on a local machine would be: curl -X GET http://localhost:9980/

The rest of the guide assumes each request is prefixed with the localhost/ip and port as needed and only lists the end-points addresses.

Syntax

GET /

Request

GET / HTTP/1.1

Response

HTTP/1.1 200 OK
Content-Type: application/vizrt.promoserver+xml; type=root
<promoserver:root xmlns:promoserver="http://www.vizrt.com/promoserver">
<promoserver:refLink rel="channels" type="application/vizrt.promoserver+xml; type=channelsList" href="http://localhost:9980/config/channels" />
<promoserver:refLink rel="globalsettings" type="application/vizrt.promoserver+xml; type=globalsettingsList" href="http://localhost:9980/config/globalsettings" />
</promoserver:root>

Disallowed Actions

This end-point does not allow POST, PUT or DELETE, and will return a 'HTTP/1.1 405 Method Not Allowed'.