Sign in

v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB
Hosts

Mute a host

Mute a host. Note: This creates a Downtime V2 for the host.

post/api/v1/host/{host_name}/mute

Path parameters

host_namestring required

Name of the host to mute.

Request body

endinteger

POSIX timestamp in seconds when the host is unmuted. If omitted, the host remains muted until explicitly unmuted.

messagestring

Message to associate with the muting of this host.

overrideboolean

If true and the host is already muted, replaces existing host mute settings.

Example request

{
  "end": 1579098130,
  "message": "Muting this host for a test!"
}

Response

OK

actionstring

Action applied to the hosts.

endinteger

POSIX timestamp in seconds when the host is unmuted.

hostnamestring

The host name.

messagestring

Message associated with the mute.

Example response

{
  "action": "Muted",
  "end": 1579098130,
  "hostname": "test.host",
  "message": "Muting this host for a test!"
}