PRprss
Destinations

Create a destination health record (please note - this endpoint is in alpha mode and may change or be removed in the future).

Changed on

Create a new health record for the specified destination.

post/api/v2/destinations/healths

Request

  • Base URL
    https://contentdepot.prss.org (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Authorization code: /api/oauth2/authorize
    Token URL: /api/oauth2/token scopes: cd:full

Request body

destinationIdinteger required

The ID of the related destination.

destinationType'XDS_PRO' | 'FTP' | 'ICECAST' | 'CODEC' | 'CD_EDGE' required

The type of the related destination.

healthyboolean required

Whether or not the destination is reporting to be healthy

messagestring required

Description of device health

detailsstring required

Destination type specific details. Details pending.

reportedDatestring date-time required

The time this health information was reported

Response

The created destination health record

idinteger

The ID of the created health record

destinationIdinteger

The ID of the related destination.

destinationType'XDS_PRO' | 'FTP' | 'ICECAST' | 'CODEC' | 'CD_EDGE'

The type of the related destination.

healthyboolean

Whether or not the destination is reporting to be healthy

messagestring

Description of device health

detailsstring

Destination type specific details. Details pending.

reportedDatestring date-time

The time this health information was reported

createdDatestring date-time

When this health record was created

lastModifiedDatestring date-time

When this health record was last modified

Changes