Media Relay



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/media-relay

Summary


Resources Methods
https://localhost:8443/api/rest/media-relay

 GET  Get media relay configuration of the DMA.

PUT Updates configuration for media relay.

https://localhost:8443/api/rest/media-relay/status

 GET  Get media relay service status of the DMA.

Resources


https://localhost:8443/api/rest/media-relay


Methods

GET


Get media relay configuration of the DMA.
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-media-relay-configuration+xml
application/vnd.plcm.plcm-media-relay-configuration+json
 Media relay information successfully retrieved.
304
Media relay configuration has not changed since last search
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
 Permission denied. DMA roles required: administrator, provisioner

PUT

Updates configuration for media relay. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-media-relay-configuration+xml
application/vnd.plcm.plcm-media-relay-configuration+json

Response

Status Representation Description
204 Media relay successfully updated.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
 Bad request.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
 Unable to get permission. User roles required: administrator.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
 Invlid port range specified (start less than end, start greater than 1024, start less than equal to 65535).
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
 A port range conflicts with other ports for services configured on the system.

https://localhost:8443/api/rest/media-relay/status


Methods

GET


Get media relay service status of the DMA.
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-media-relay-status+xml
application/vnd.plcm.plcm-media-relay-status+json
 Current media relay status successfully retrieved.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
 Permission denied. DMA roles required: administrator, provisioner