HEALTH

Allows you to check the health of the VIS API and internal services.


Publishing Point URL Object

{
    "url": "http://example.site/path/to/publishing-point",
    "state": "started",
    "hasStarted": true,
    "lastUpdated": "1970-01-01T12:00:00Z",
    "receivingData": true
}

Supported Actions

GET /health/

Check the health of the VIS and internal services.

Response: 200 OK or 503 Service Unavailable if an issue occurred within service.


GET /live/stream/

Get the Publishing Point information for all currently live Events.

Query Parameters:

CheckForErrors:   {bool} - Optional. Defaults to False, if True then will return HttpStatusCode 415 if any Publishing Point has not started or is no longer receiving data.

Response: 415 Expectation Failed or 200 OK and a dictionary of Event IDs and Publishing Point URL Objects.


GET /live/stream/{channelId}

Get the Publishing Point information for a given Channel by Id.

Query Parameters:

CheckForErrors:   {bool} - Optional. Defaults to False, if True then will return HttpStatusCode 415 if any Publishing Point has not started or is no longer receiving data.

Response: 415 Expectation Failed or 200 OK and a dictionary of Event IDs and Publishing Point URL Objects.


GET /live/stream/notstarted/

Query if any Events have not started that were scheduled to have started.

Query Parameters:

Buffer: {int} - Optional. Defaults to 5. This is the number of minutes allowance before being considered "not started".

Response: 415 Expectation Failed if any Events have not started. Else 200 OK.


GET /live/stream/notstopped/

Query if any Events have not stopped that were scheduled to have stopped.

Query Parameters:

Buffer: {int} - Optional. Defaults to 5. This is the number of minutes allowance before being considered "not stopped".

Response: 415 Expectation Failed if any Events have not stopped. Else 200 OK.


GET /live/stream/notlive2vod/

Query if any Events have not converted to VOD.

Query Parameters:

Buffer: {int} - Optional. Defaults to 24. This is the number of hours allowance before being considered "not converted".

Response: 415 Expectation Failed if any Events have not converted. Else 200 OK.