PRprobely
Blackout Periods

Create Blackout Period

Changed on
post/targets/{target_id}/blackout-periods/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/targets/{target_id}/blackout-periods/
  • Auth
    API key in header Authorization

Path parameters

target_idstring required

Identifier of the target.

Request body

idstring required

A unique Base58 value identifying this object.

beginstring time required

Time of when the blackout period starts, in ISO 8601 UTC format.
For example, "13:27".

ceasestring time required

Time of when the blackout period ceases, in ISO 8601 UTC format.
For example, "13:27".

weekdaysinteger[] required
enabledboolean

If true, the blackout period is enabled.

timezonestring
changedstring date-time required

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

Response

idstring required

A unique Base58 value identifying this object.

beginstring time required

Time of when the blackout period starts, in ISO 8601 UTC format.
For example, "13:27".

ceasestring time required

Time of when the blackout period ceases, in ISO 8601 UTC format.
For example, "13:27".

weekdaysinteger[] required
enabledboolean

If true, the blackout period is enabled.

timezonestring
changedstring date-time required

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

Changes