icinga2client.api package

Module contents

class icinga2client.api.ApiClient(base_uri, verify=True)

Bases: icinga2client.api.methods.APIMethodsMixin

api_prefix = 'v1'
authenticate(**kwargs)
default_headers = {'Accept': 'application/json'}
request(method, command, data=None, headers={}, **kwargs)

Make an API request.

Parameters:
  • method (str) – The HTTP verb used in the request.
  • command (str) – The path of the command, excluding the prefix. For example: objects/hosts or actions/acknowledge-problem.
  • data (object) – Additional request data. Must be serializable by json.dumps.
  • headers (dict) – Any additional HTTP headers.
request_parameters = {}
set_request_option(option, value)
url(command)
class icinga2client.api.Comment(author, text)

Bases: tuple

author

Alias for field number 0

text

Alias for field number 1