{"id":26002749,"url":"https://github.com/1and1/checkmk-java-client","last_synced_at":"2026-04-11T17:03:06.065Z","repository":{"id":65507880,"uuid":"577406093","full_name":"1and1/checkmk-java-client","owner":"1and1","description":"Java REST client for the Checkmk monitoring","archived":false,"fork":false,"pushed_at":"2024-04-08T01:01:06.000Z","size":378,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-04-19T22:49:04.603Z","etag":null,"topics":["checkmk","client","java","library","maven","okhttp3","openapi","rest","rest-client"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/1and1.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-12-12T17:02:04.000Z","updated_at":"2024-03-31T14:26:15.000Z","dependencies_parsed_at":"2023-12-27T10:24:28.286Z","dependency_job_id":"5a221fc2-53d1-4ed8-b309-fd005bff824e","html_url":"https://github.com/1and1/checkmk-java-client","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1and1%2Fcheckmk-java-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1and1%2Fcheckmk-java-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1and1%2Fcheckmk-java-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1and1%2Fcheckmk-java-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/1and1","download_url":"https://codeload.github.com/1and1/checkmk-java-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242091082,"owners_count":20070276,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["checkmk","client","java","library","maven","okhttp3","openapi","rest","rest-client"],"created_at":"2025-03-05T19:30:12.128Z","updated_at":"2025-12-02T21:02:10.860Z","avatar_url":"https://github.com/1and1.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CheckMK Java Client\n\n[![OpenAPI code generation](https://github.com/1and1/checkmk-java-client/actions/workflows/generate.yaml/badge.svg)](https://github.com/1and1/checkmk-java-client/actions/workflows/generate.yaml)\n[![Maven Central](https://img.shields.io/maven-central/v/com.oneandone/checkmk-java-client)](https://maven-badges.herokuapp.com/maven-central/com.oneandone/checkmk-java-client)\n[![javadoc](https://javadoc.io/badge2/com.oneandone/checkmk-java-client/javadoc.svg)](https://javadoc.io/doc/com.oneandone/checkmk-java-client)\n[![License: GPL v2](https://img.shields.io/badge/License-GPL_v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)\n\nA Java REST API library that connects to a [CheckMK](https://github.com/tribe29/checkmk) monitoring system server.\n\n## What's inside\n\nThis repository contains just scripts to build the client. It does not\ncontain the source code that is being generated. Source code, library jar and\nJavadoc is on Maven Central.\n\nThe REST client is generated using the [OpenAPI generator](https://github.com/OpenAPITools/openapi-generator)\nwith the target language being Java, the HTTP client being okhttp\nand bean validation turned on.\n\n## Documentation\n\nThe Java API documentation can be browsed on [Javadoc.io](https://javadoc.io/doc/com.oneandone/checkmk-java-client).\n\nThe REST API documentation can be browsed in your local Checkmk installation.\n\n## Using the client in your code\n\n### Maven artifact\n\nThe client is provided as a Maven artifact. By adding this dependency to your POM,\nyou'll be able to use the client:\n\n```xml\n  \u003cgroupId\u003ecom.oneandone\u003c/groupId\u003e\n  \u003cartifactId\u003echeckmk-java-client\u003c/artifactId\u003e\n  \u003cversion\u003e$THE_VERSION_TO_USE\u003c/version\u003e\n```\n\nFor the appropriate version, please see the [\"Version numbers\"](#version-numbers) section below\nand see [Maven Central](https://search.maven.org/search?q=g:com.oneandone%20AND%20a:checkmk-java-client)\nversions.\n\n### Demo code\n\nA simple API client showing the [Checkmk version information](demo/src/main/java/com/ionos/network/checkmk/demo/Main.java)\nis in the demo project.\nIt uses a custom [ApiClient](demo/src/main/java/com/ionos/network/checkmk/demo/CustomApiClient.java)\nto overcome a problem in sending the Accept header.\n\n## Generating the client code\n\nThe client code can be generated with\n\n```bash\n~ ./generate.sh\n```\n\n## Version numbers\n\nVersion numbers are composed of two parts:\n\n1. First two segments: The generator script version.\n2. Last segments: The Checkmk API version specification.\n\nExample: Version `1.0.2.1.0.17` is composed of the parts\n\n* `1.0` being the generator script\nversion, and \n* `2.1.0.17` referencing to the Checkmk API `2.1.0p17`.\n\n## Changes compared to the generated client\n\nThere are multiple changes compared to the pure generated client. The\ngenerated client would not build because of certain shortcomings of\nOpenAPI generator.\n\n* Replacement of [AnyOf](https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/)-based OpenAPI types with Java Map types.\n  OpenAPI generator 5.4 does not natively support AnyOf-types.\n* Fixing of syntactic errors, i.e. combination of `@NotNull`-annotation with type names (i.e. `@NotNullString` instead of `@NotNull String`).\n* Update of several depencency versions, i.e. okhttp and gson.\n* Inclusion of the SonaType OSS artifact repository into the POM.\n\n## License\n\nThis repository is licensed under the [GPL 2.0](LICENSE) license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1and1%2Fcheckmk-java-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F1and1%2Fcheckmk-java-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1and1%2Fcheckmk-java-client/lists"}