{"id":27558,"date":"2023-09-01T16:32:23","date_gmt":"2023-09-01T14:32:23","guid":{"rendered":"https:\/\/www.dbi-services.com\/blog\/?p=27558"},"modified":"2024-09-11T10:18:26","modified_gmt":"2024-09-11T08:18:26","slug":"zabbix-configuration-with-api","status":"publish","type":"post","link":"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/","title":{"rendered":"Zabbix Configuration with API"},"content":{"rendered":"\n

Despite the will of Zabbix to be as automated as possible, some tasks cannot be automated. Nevertheless, Zabbix offers an HTTP-based API which can be used programmatically.<\/p>\n\n\n\n

This opens the door to huge possibilities in terms of automation.<\/p>\n\n\n\n

JSON-RPC<\/h2>\n\n\n\n

JSON-RPC is a stateless, light-weight remote procedure call (RPC) protocol. In regard to Zabbix, we simply have to post HTTP requests to Zabbix web server to create, update or delete configuration entities.<\/p>\n\n\n\n

Authentication<\/h2>\n\n\n\n

The usual workflow is to first an authentication token (also via HTTP request) and then use that token in subsequent HTTP requests. For example:<\/p>\n\n\n

\n# curl --request POST \\\n>   --url 'http:\/\/<zabbix_server>:8080\/api_jsonrpc.php' \\\n>   --header 'Content-Type: application\/json-rpc' \\\n>   --data '{"jsonrpc":"2.0","method":"user.login","params":{"username":"Admin","password":"zabbix"},"id":1}'\n{"jsonrpc":"2.0","result":"63b2cc9388daaaa0e150a0e2ccce6a68","id":1}\n<\/pre><\/div>\n\n\n
This is nice, but a bit too heavy.<\/p>\n\n\n\n
Another solution is to create an API token directly in Zabbix frontend. In Users, API tokens section, click “Create API token”, following window will open:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
It is recommended to set an expiration date and renew it as needed. You can see that I selected a user. I created a dedicated service user which is admin but has no right to login to front end (part of No access to the frontend<\/em> group).<\/p>\n\n\n\n
On next screen, the API token will be display:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Copy it and store it in a safe place as it will not be possible to display it (only regenerating it).<\/p>\n\n\n\n
Auto-registration Actions<\/h2>\n\n\n\n
Auto-registration is a cool way to have host integrated into Zabbix server as I demonstrated it in this blog post<\/a>. However, auto-registration actions setup cannot be imported from a file. If we want a consistent configuration across multiple Zabbix server, this configuration must be automated. As it is plain text, it is also possible to version that in a GIT repository.<\/p>\n\n\n\n
API will help us in that matter.<\/p>\n\n\n\n
There is a long chapter in Zabbix documentation about the API<\/a> detailing all the methods and arguments.<\/p>\n\n\n\n
First, I create a JSON file which contains details about the auto-registration action:<\/p>\n\n\n
\n{\n    "jsonrpc": "2.0",\n    "method": "action.create",\n    "params": {\n        "name": "Register Linux",\n        "eventsource": "2",\n        "filter": {\n            "evaltype": "2",\n            "conditions": [\n                {\n                    "conditiontype": "22",\n                    "operator": "2",\n                    "value": "linux"\n                }\n            ]\n        },\n        "operations": [\n            {\n                "operationtype": "4",\n                "opgroup": [\n                    {\n                        "groupid": "2"\n                    }\n                ]\n            }\n        ]\n    }\n        ,"auth":"1166aaaaa8b9d1ad8b848744e1a6edf760b9ef9bcbbbbbbbdd98ca7",\n    "id": 1\n}\n<\/pre><\/div>\n\n\n
You will have to replace auth<\/code> value by the API token you have generated in the Web UI.<\/p>\n\n\n\n
Next, the curl command looks like:<\/p>\n\n\n
\ncurl -s --request POST \\\n --url 'http:\/\/<zabbix_server>:8080\/api_jsonrpc.php' \\\n --header 'Content-Type: application\/json-rpc' \\\n --data @create_action.json\n<\/pre><\/div>\n\n\n
If everything goes well, server will return a JSON string like the following:<\/p>\n\n\n
\n{"jsonrpc":"2.0","result":{"actionids":["20"]},"id":1}\n<\/pre><\/div>\n\n\n
actionids is the ID in Zabbix configuration. It can be useful if an update via the API is required. It can also be found with curl on action.get<\/code> method:<\/p>\n\n\n
\ncurl -s --request POST \\\n --url 'http:\/\/&lt;zabbix_server&gt;:8080\/api_jsonrpc.php' \\\n --header 'Content-Type: application\/json-rpc' \\\n --data @get_action.json\n<\/pre><\/div>\n\n\n
Where get_action.json<\/code> looks like this:<\/p>\n\n\n
\n{\n  "jsonrpc": "2.0",\n  "method": "action.get",\n  "params": {\n    "filter": {\n      "name": "Register Linux"\n    }\n  },\n  "auth": "1166aaaaa8b9d1ad8b848744e1a6edf760b9ef9bcbbbbbbbdd98ca7",\n  "id": 1\n}\n<\/pre><\/div>\n\n\n
And, finally, command output looks like this:<\/p>\n\n\n
\n{\n  "jsonrpc": "2.0",\n  "result": [\n    {\n      "actionid": "20",\n      "name": "Register Linux",\n      "eventsource": "2",\n      "status": "0",\n      "esc_period": "1h",\n      "pause_suppressed": "1",\n      "notify_if_canceled": "1",\n      "pause_symptoms": "1"\n    }\n  ],\n  "id": 1\n}\n<\/pre><\/div>","protected":false},"excerpt":{"rendered":"
Despite the will of Zabbix to be as automated as possible, some tasks cannot be automated. Nevertheless, Zabbix offers an HTTP-based API which can be used programmatically. This opens the door to huge possibilities in terms of automation. JSON-RPC JSON-RPC is a stateless, light-weight remote procedure call (RPC) protocol. In regard to Zabbix, we simply […]<\/p>\n","protected":false},"author":40,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[197],"tags":[694,2430],"type_dbi":[],"class_list":["post-27558","post","type-post","status-publish","format-standard","hentry","category-application-integration-middleware","tag-json","tag-zabbix"],"acf":[],"yoast_head":"\nZabbix Configuration with API - dbi Blog<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Zabbix Configuration with API\" \/>\n<meta property=\"og:description\" content=\"Despite the will of Zabbix to be as automated as possible, some tasks cannot be automated. Nevertheless, Zabbix offers an HTTP-based API which can be used programmatically. This opens the door to huge possibilities in terms of automation. JSON-RPC JSON-RPC is a stateless, light-weight remote procedure call (RPC) protocol. In regard to Zabbix, we simply […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/\" \/>\n<meta property=\"og:site_name\" content=\"dbi Blog\" \/>\n<meta property=\"article:published_time\" content=\"2023-09-01T14:32:23+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-09-11T08:18:26+00:00\" \/>\n<meta name=\"author\" content=\"Middleware Team\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Middleware Team\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/\"},\"author\":{\"name\":\"Middleware Team\",\"@id\":\"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/8d8563acfc6e604cce6507f45bac0ea1\"},\"headline\":\"Zabbix Configuration with API\",\"datePublished\":\"2023-09-01T14:32:23+00:00\",\"dateModified\":\"2024-09-11T08:18:26+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/\"},\"wordCount\":385,\"commentCount\":0,\"keywords\":[\"json\",\"Zabbix\"],\"articleSection\":[\"Application integration & Middleware\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/\",\"url\":\"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/\",\"name\":\"Zabbix Configuration with API - dbi Blog\",\"isPartOf\":{\"@id\":\"https:\/\/www.dbi-services.com\/blog\/#website\"},\"datePublished\":\"2023-09-01T14:32:23+00:00\",\"dateModified\":\"2024-09-11T08:18:26+00:00\",\"author\":{\"@id\":\"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/8d8563acfc6e604cce6507f45bac0ea1\"},\"breadcrumb\":{\"@id\":\"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"https:\/\/www.dbi-services.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Zabbix Configuration with API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.dbi-services.com\/blog\/#website\",\"url\":\"https:\/\/www.dbi-services.com\/blog\/\",\"name\":\"dbi Blog\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.dbi-services.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/8d8563acfc6e604cce6507f45bac0ea1\",\"name\":\"Middleware Team\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/secure.gravatar.com\/avatar\/ddcae7ba0f9d1a0e7ae707f0e689e4a9c95bb48ec49c8e6d9cc86d43f4121cb6?s=96&d=mm&r=g\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/ddcae7ba0f9d1a0e7ae707f0e689e4a9c95bb48ec49c8e6d9cc86d43f4121cb6?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/ddcae7ba0f9d1a0e7ae707f0e689e4a9c95bb48ec49c8e6d9cc86d43f4121cb6?s=96&d=mm&r=g\",\"caption\":\"Middleware Team\"},\"url\":\"https:\/\/www.dbi-services.com\/blog\/author\/middleware-team\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Zabbix Configuration with API - dbi Blog","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/","og_locale":"en_US","og_type":"article","og_title":"Zabbix Configuration with API","og_description":"Despite the will of Zabbix to be as automated as possible, some tasks cannot be automated. Nevertheless, Zabbix offers an HTTP-based API which can be used programmatically. This opens the door to huge possibilities in terms of automation. JSON-RPC JSON-RPC is a stateless, light-weight remote procedure call (RPC) protocol. In regard to Zabbix, we simply […]","og_url":"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/","og_site_name":"dbi Blog","article_published_time":"2023-09-01T14:32:23+00:00","article_modified_time":"2024-09-11T08:18:26+00:00","author":"Middleware Team","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Middleware Team","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/#article","isPartOf":{"@id":"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/"},"author":{"name":"Middleware Team","@id":"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/8d8563acfc6e604cce6507f45bac0ea1"},"headline":"Zabbix Configuration with API","datePublished":"2023-09-01T14:32:23+00:00","dateModified":"2024-09-11T08:18:26+00:00","mainEntityOfPage":{"@id":"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/"},"wordCount":385,"commentCount":0,"keywords":["json","Zabbix"],"articleSection":["Application integration & Middleware"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/","url":"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/","name":"Zabbix Configuration with API - dbi Blog","isPartOf":{"@id":"https:\/\/www.dbi-services.com\/blog\/#website"},"datePublished":"2023-09-01T14:32:23+00:00","dateModified":"2024-09-11T08:18:26+00:00","author":{"@id":"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/8d8563acfc6e604cce6507f45bac0ea1"},"breadcrumb":{"@id":"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.dbi-services.com\/blog\/zabbix-configuration-with-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"https:\/\/www.dbi-services.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Zabbix Configuration with API"}]},{"@type":"WebSite","@id":"https:\/\/www.dbi-services.com\/blog\/#website","url":"https:\/\/www.dbi-services.com\/blog\/","name":"dbi Blog","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.dbi-services.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/8d8563acfc6e604cce6507f45bac0ea1","name":"Middleware Team","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/ddcae7ba0f9d1a0e7ae707f0e689e4a9c95bb48ec49c8e6d9cc86d43f4121cb6?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/ddcae7ba0f9d1a0e7ae707f0e689e4a9c95bb48ec49c8e6d9cc86d43f4121cb6?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/ddcae7ba0f9d1a0e7ae707f0e689e4a9c95bb48ec49c8e6d9cc86d43f4121cb6?s=96&d=mm&r=g","caption":"Middleware Team"},"url":"https:\/\/www.dbi-services.com\/blog\/author\/middleware-team\/"}]}},"_links":{"self":[{"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/posts\/27558","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/users\/40"}],"replies":[{"embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/comments?post=27558"}],"version-history":[{"count":9,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/posts\/27558\/revisions"}],"predecessor-version":[{"id":27732,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/posts\/27558\/revisions\/27732"}],"wp:attachment":[{"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/media?parent=27558"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/categories?post=27558"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/tags?post=27558"},{"taxonomy":"type","embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/type_dbi?post=27558"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}