Seitenhierarchie
Zum Ende der Metadaten springen
Zum Anfang der Metadaten

URL: https://123.123.123.123/hosts/add.json

Methode: POST

Response: JSON


HostRequired for addingRequired for editingBeschreibungvererbtTypBeispiel

id
(Warnung)ID des Hosts
integer123

name(Warnung)(Warnung)Name des Hosts
string"default host"

address(Warnung)(Warnung)IP Adresse des Hosts
string"123.123.123.123"

satellite_id

ID des Satelliten falls dieser Host von einem Satelliten gemonitored werden soll
integer123

own_contacts

null = Kontakte aus Template |

1 = vom Template abweichende Kontakte


null | integernull oder 1

own_contactgroups

null = Kontaktgruppen aus Template |

1 = vom Template abweichende Kontaktgruppen


null | integernull oder 1

own_customvariables

null = keine Customvariablen |

1 = Customvariablen verwenden


null | integernull oder 1

container_id(Warnung)(Warnung)ID des Containers in dem der Host angelegt wird (1 = /root)
integer123

shared_container

IDs der Container in die der Host geshared werden soll
array[ 1, 2, 3, ....]

hosttemplate_id(Warnung)(Warnung)ID des Hosttemplates von der Host seine Einstellungen erbt
integer123

description

Beschreibung des Hosts
(Haken)
string"host Beschreibung"

Hostgroup(Warnung)(Warnung)IDs der Hostgruppen in denen der Host sein soll(Haken)array[ 1, 2, 3, ....]

Parenthost
(Warnung)ID des Parenthosts
null | integernull oder 123

notes

Notizen zu dem Host(Haken)string"Lorem ipsum dolor sit amet"

host_url

URL des Hosts(Haken)string"http://hosturl.com"

priority

Priorität des Hosts (noch nicht implementiert)(Haken)null | integernull oder 1

tags

Host spezifisches Label(Haken)string"Lorem ipsum dolor sit amet"

notify_period_id

ID der notification_period(Haken)integer123

notification_interval(Warnung)
Intervall der Notifikationen in Sekunden(Haken)integer123

notify_on_recovery

Notifikation bei Recovery(Haken)null | integernull oder 1

notify_on_down

Notifikation bei Down(Haken)null | integernull oder 1

notify_on_unreachable

Notifikation bei Unreachable(Haken)null | integernull oder 1

notify_on_flapping

Notifikation bei Flapping(Haken)null | integernull oder 1

notify_on_downtime

Notifikation bei Downtime(Haken)null | integernull oder 1

active_checks_enabled

Wird der Host aktiv gecheckt(Haken)null | integernull oder 1

Contact

IDs der Kontakte(Haken)array[ 1, 2, 3, ....]

Contactgroup

IDs der Kontaktgruppen(Haken)array[ 1, 2, 3, ....]

command_id(Warnung)
ID des Kommandos(Haken)null | integernull oder 123

check_period_id

ID der check_period(Haken)null | integernull oder 123

max_check_attempts

Wie oft soll maximal gechecked werden
null | integernull oder Anzahl

check_interval(Warnung)
Intervall des checks in Sekunden(Haken)null | integernull oder 123

retry_interval(Warnung)
Intervall beim retry in Sekunden(Haken)null | integernull oder 123

flap_detection_enabled

Soll die flap_detection aktiv sein(Haken)null | integernull oder 1

flap_detection_on_up

flap_detection im Status "up"(Haken)null | integernull oder 1

flap_detection_on_down

flap_detection im Status "down"(Haken)null | integernull oder 1

flap_detection_on_unreachable

flap_detection im Status "unreachable"(Haken)null | integernull oder 1

JSON zum Erzeugen eines Hosts via REST API
{
    "Host" : {
        "name":"api host",
        "address":"127.0.0.1",
        "satellite_id":0,
        "own_contacts":null,
        "own_contactgroups":null,
        "own_customvariables":null,
        "container_id":1,
        "shared_container":[],
        "hosttemplate_id":1,
        "description":"",
        "Hostgroup":[],
        "Parenthost":null,
        "notes":"",
        "host_url":"",
        "priority":null,
        "tags":"",
        "notify_period_id":1,
        "notification_interval":null,
        "notify_on_recovery":null,
        "notify_on_down":null,
        "notify_on_unreachable":null,
        "notify_on_flapping":null,
        "notify_on_downtime":null,
        "active_checks_enabled":null,
        "Contact":[],
        "Contactgroup":[],
        "command_id":$COMMAND_ID,
        "check_period_id":null,
        "max_check_attempts":null,
        "check_interval":null,
        "retry_interval":null,
        "flap_detection_enabled":null,
        "flap_detection_on_up":null,
        "flap_detection_on_down":null,
        "flap_detection_on_unreachable":null
    },
    "Hostcommandargumentvalue":[],
    "Customvariable":{
		"1":{
			"name":"NAME1",
			"value":"$VALUE",
			"objecttype_id":256
		}
	}
}
Minimales JSON
{
    "Host" : {
        "name":"api host",
        "address":"127.0.0.1",
        "container_id":1,
        "hosttemplate_id":1,
        "notification_interval":null,
        "check_interval":null,
        "Hostgroup":[],
        "retry_interval":null
    }
}
Response bei erfolgreichem Aufruf
{
  "id": "123"
}
Beispielhafter Fehlercode wenn man die Container ID nicht übergibt
{
  "error": {
    "container_id": [
      "Invalid container."
    ]
  }
}
  • Keine Stichwörter