Documentation Center

Viz Channel Branding User Guide

Version 5.1 | Published October 26, 2023 ©

POST Machine Address

Adds a new machine address to a channel Promo Server configuration.

Note: Machine address names are not case sensitive, i.e. localhost is the same as LOCALHOST

Syntax

POST /config/channels/{channelname}/machineaddresses

Request

POST /config/channels/Test/machineaddresses HTTP/1.1
Content-Type: application/vizrt.promoserver+xml; type=machineAddress
<promoserver:machineAddress xmlns:promoserver="http://www.vizrt.com/promoserver">
<promoserver:name>secondarybackuphost</promoserver:name>
</promoserver:machineAddress>

Response - New machine address was added to the configured list of machine addresses for a channel

HTTP/1.1 200 OK
Content-Type: application/vizrt.promoserver+xml; type=machineAddressesList
<promoserver:machineAddressesList xmlns:promoserver="http://www.vizrt.com/promoserver">
<promoserver:machineAddress>
<promoserver:refLink rel="self" type="application/vizrt.promoserver+xml; type=machineAddress" href="http://localhost:9980/config/channels/Test/machineaddresses/localhost" />
<promoserver:refLink rel="edit" type="application/vizrt.promoserver+xml; type=machineAddress" href="http://localhost:9980/config/channels/Test/machineaddresses/localhost" />
<promoserver:refLink rel="status" type="application/vizrt.promoserver+xml; type=machineAddressStatus" href="http://localhost:9980/config/channels/Test/machineaddresses/localhost/status" />
<promoserver:name>localhost</promoserver:name>
</promoserver:machineAddress>
<promoserver:machineAddress>
<promoserver:refLink rel="self" type="application/vizrt.promoserver+xml; type=machineAddress" href="http://localhost:9980/config/channels/Test/machineaddresses/backuphost" />
<promoserver:refLink rel="edit" type="application/vizrt.promoserver+xml; type=machineAddress" href="http://localhost:9980/config/channels/Test/machineaddresses/backuphost" />
<promoserver:refLink rel="status" type="application/vizrt.promoserver+xml; type=machineAddressStatus" href="http://localhost:9980/config/channels/Test/machineaddresses/backuphost/status" />
<promoserver:name>backuphost</promoserver:name>
</promoserver:machineAddress>
<promoserver:machineAddress>
<promoserver:refLink rel="self" type="application/vizrt.promoserver+xml; type=machineAddress" href="http://localhost:9980/config/channels/Test/machineaddresses/secondarybackuphost" />
<promoserver:refLink rel="edit" type="application/vizrt.promoserver+xml; type=machineAddress" href="http://localhost:9980/config/channels/Test/machineaddresses/secondarybackuphost" />
<promoserver:refLink rel="status" type="application/vizrt.promoserver+xml; type=machineAddressStatus" href="http://localhost:9980/config/channels/Test/machineaddresses/secondarybackuphost/status" />
<promoserver:name>secondarybackuphost</promoserver:name>
</promoserver:machineAddress>
</promoserver:machineAddressesList>

Error Response - Machine address already exists

HTTP/1.1 409 Conflict
Content-Type: application/xml; charset=utf-8
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">Element of name localhost already exists</string>

Error Response - Channel not found

HTTP/1.1 404 Not Found
Content-Type: application/xml; charset=utf-8
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">Element Test could not be found</string>

Error Response - Invalid host name

HTTP/1.1 400 Bad Request
Content-Type: application/xml; charset=utf-8
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">Input content is invalid: Machine address 'host#' is not a valid host name</string>