Actions¶

acknowledge¶

POST /v2/actions/acknowledge¶

Acknowledge a host/service. :type ack: Acknowledgement

Return type:	`Info`

DELETE /v2/actions/acknowledge¶

Delete a host/service acknowledgement. :type ack: Acknowledgement

Return type:	`Info`

downtime¶

POST /v2/actions/downtime¶

Put a host/service in downtime. :type dt: Downtime

Return type:	`Info`

DELETE /v2/actions/downtime¶

Delete a host/service downtime. :type dt: Downtime

Return type:	`Info`

types documentation¶

type Acknowledgement¶

Data samples:

Json

{
    "author": "aviau", 
    "comment": "Working on it.", 
    "host_name": "localhost", 
    "notify": 0, 
    "persistent": 1, 
    "service_description": "ws-arbiter", 
    "sticky": 1, 
    "time_stamp": ""
}

XML

<value>
  <host_name>localhost</host_name>
  <service_description>ws-arbiter</service_description>
  <time_stamp />
  <sticky>1</sticky>
  <notify>0</notify>
  <persistent>1</persistent>
  <author>aviau</author>
  <comment>Working on it.</comment>
</value>

host_name¶

Type:	unicode

The name of the host

type Downtime¶

Data samples:

Json

{
    "author": "aviau", 
    "comment": "No comment.", 
    "duration": 86400, 
    "end_time": 1430150469, 
    "fixed": 1, 
    "host_name": "localhost", 
    "service_description": "ws-arbiter", 
    "start_time": 1430150469, 
    "time_stamp": 1430150469, 
    "trigger_id": 0
}

XML

<value>
  <host_name>localhost</host_name>
  <service_description>ws-arbiter</service_description>
  <time_stamp>1430150469</time_stamp>
  <start_time>1430150469</start_time>
  <end_time>1430150469</end_time>
  <fixed>1</fixed>
  <duration>86400</duration>
  <trigger_id>0</trigger_id>
  <author>aviau</author>
  <comment>No comment.</comment>
</value>

author¶

Type:	unicode

The author of the downtime

comment¶

Type:	unicode

Comment for the downtime

duration¶

Type:	int

The duration of the downtime, in seconds

end_time¶

Type:	int

When to end the downtime

host_name¶

Type:	unicode

The name of the host

service_description¶

Type:	unicode

Ther service description

start_time¶

Type:	int

When to start the downtime

time_stamp¶

Type:	int

Time stamp for the downtime