Downtimes (actiondowntime)

The actiondowntime contains the downtimes requested and processed.

To schedule a downtime for an host/service the client post on this endpoint to create a new downtime request that will be managed by the Alignak backend Broker module to build an external command notified to the Alignak framework.

Note that the Alignak Web Services module allow to use more external commands.

../_images/actiondowntime.png
Properties
Property Type Required Default Relation
Realm
objectid     realm
Sub-realms
boolean   True  
_users_read
objectid list     user
Action
string   add  
Comment
string      
Duration
integer   86400  
End time
integer   86400  
Fixed
boolean   True  
Host
objectid True   host
Notified
boolean   False  
Processed
boolean   False  
schema_version
integer   1  
Service
objectid True   service
Start time
integer   0  
User
objectid True   user

_realm: Realm this element belongs to. Note that this property will always be forced to the value of the concerned host realm.

_sub_realm: Is this element visible in the sub-realms of its realm?

action: Use “add” to add a new downtime, or “delete” to delete an downtime

Allowed values: [‘add’, ‘delete’]

comment: The comment of the downtime action. Free text.

duration: The duration property is used when the fixed property is not set.

end_time: The start_time and end_time properties are specified in time_t format (seconds since the UNIX epoch).

fixed: If the fixed argument is set, the downtime will start and end at the times specified by the start_time and end_time properties. Otherwise, the downtime will begin between the start_time and end_time times and will last for duration seconds.

host: The host concerned by the downtime.

notified: The action has been fetched by the Alignak arbiter if notified is True but it is not yet to be considered as an effective scheduled downtime

processed: The action has been set on the host/service by Alignak and it can be considered as effective if processed is True

service: The service concerned by the downtime.

start_time: The start_time and end_time properties are specified in time_t format (seconds since the UNIX epoch).

user: The user concerned by the downtime.