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/

Check the Publishing Point information for all currently live Events.

Query Parameters:

Name Type Required Description
checkForErrors bool No If True then will return a 415 if any Publishing Point has not started or is not receiving data.

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


GET /live/stream/{channelId}

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

This request behaves the same as a the standard live check, but with a different route.


GET /live/stream/{eventId}

Check the Publishing Point information for a given Event by Id.

This request behaves the same as a the standard live check, but with a different route.


GET /live/stream/notstarted/

Check if there are any Events that were scheduled to start, but have not yet done so.

Query Parameters:

Name Type Required Description
buffer int No Defaults to 5. This is the number of minutes allowed before being considered "not started".

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


GET /live/stream/notstopped/

Check if there are any Events that were scheduled to stop, but have not yet done so.

Query Parameters:

Name Type Required Description
buffer int No Defaults to 5. This is the number of minutes allowed before being considered "not stopped".

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


GET /live/stream/notlive2vod/

Check if there are any Events that were scheduled to convert to VOD but have not yet done so.

Query Parameters:

Name Type Required Description
buffer int No Defaults to 24. This is the number of hours allowed before being considered "not converted".

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


GET /live/dynamic/stream/notprovisioned/

Check if there are any Events that were scheduled to Provision, but have not yet done so.

Query Parameters:

Name Type Required Description
buffer int No Defaults to 5. This is the number of minutes allowed before being considered "not provisioned".

Response: 200 OK or 415 Expectation Failed and a dictionary of Event Ids and scheduled provisioned times.


GET /live/dynamic/stream/notterminated/

Check if there are any Events that were scheduled to Terminate, but have not yet done so.

Query Parameters:

Name Type Required Description
buffer int No Defaults to 5. This is the number of minutes allowed before being considered "not terminated".

Response: 200 OK or 415 Expectation Failed and a dictionary of Event Ids and scheduled terminate times.