python-glpi-utils

Python client for GLPI that handles both of its APIs for you: the legacy REST API and the OAuth2 High-Level API, sync or async, with pagination and token refresh built in.

You write api.ticket.get_all_pages() instead of managing session tokens, Content-Range headers, OAuth2 expiry and the different URL layout of each API. Licensed under the AGPL-3.0-or-later since 2.0.0 (1.5.0 and earlier remain MIT). Python 3.9+, depends on requests (plus aiohttp for the async clients).

pip install glpi-utils      # imported as glpi_utils

from glpi_utils import GlpiAPI

with GlpiAPI(url="https://glpi.example.com") as api:      # logs out on exit
    api.login(username="glpi", password="glpi")
    print(api.version)                                     # GLPI server version: 12.0.0

    ticket = api.ticket.create({"name": "srv-db01 unreachable", "content": "ICMP loss 100%"})
    api.ticket.add_sub_item(ticket["id"], "ITILFollowup", {"content": "On-call notified"})

    for t in api.ticket.get_all_pages():                   # every page, fetched for you
        print(t["id"], t["name"])                          # one line per ticket, e.g. 7 srv-db01 unreachable

Why this one

The most used alternative on PyPI is glpi-api. Choose by what you need:

If you only call the legacy API synchronously and want to search it by field names, glpi-api is the more established choice. Use this library for async code or for the High-Level API of GLPI 11 and 12. Both libraries work with the legacy API on GLPI 12.

Install

pip install glpi-utils             # GlpiAPI, GlpiOAuthClient
pip install "glpi-utils[async]"    # adds AsyncGlpiAPI, AsyncGlpiOAuthClient

On the GLPI side, enable the API in Setup → General → API. For the legacy API, pass app_token= only if your GLPI API client defines one. For the High-Level API, add an OAuth client in Setup → OAuth clients with the Password grant and the api scope.

Clients

from glpi_utils.oauth import GlpiOAuthClient

with GlpiOAuthClient(url="https://glpi.example.com", client_id="...", client_secret="...",
                     username="svc-api", password="...", api_version="2.3") as api:
    api.authenticate()
    api.search("Ticket", filter="status.id==1;name=like=*srv*", limit=20)

Pin api_version on the OAuth2 clients. If you leave it out, the server picks its newest High-Level API version: 2.3 on GLPI 11, 3.0 on GLPI 12. The two return different schemas. Pinning "2.3" keeps code written for GLPI 11 working on 12 (12.0.0 only adds a few fields to 2.3 and drops the Plug dropdowns); you miss the endpoints added in 3.0, such as login-session management. filter takes RSQL expressions over field names. See the OAuth2 guide for the differences.

All clients share the same accessors (api.ticket, api.computer, api.user, … or api.item("AnyItemtype")), CRUD methods, sub-items, typed exceptions (GlpiAuthError, GlpiNotFoundError, GlpiPermissionError…) and debug logging with passwords and tokens masked. Settings can come from environment variables (GLPI_URL, GLPI_USER, GLPI_USER_TOKEN, GLPI_OAUTH_CLIENT_ID, GLPI_API_VERSION…).

Documentation

Guides and API reference: https://giovanny07.github.io/python-glpi-utils/

• Quick start and authentication
• CRUD, sub-items and the search engine
• Pagination
• OAuth2 and the High-Level API, including GLPI 12 / API 3.0
• Error handling and logging
• Runnable scripts in examples/

Status

Beta, actively maintained. Releases follow semantic versioning and every change is listed in the CHANGELOG. The legacy clients are the most stable part. The OAuth2 clients follow GLPI's High-Level API, which is still evolving, and their behaviour changed in 1.4 and 1.5.

The plan is to declare the library stable in 2.1.0. That needs four consecutive weeks of passing integration runs against GLPI 10, 11 and 12, counted from 2026-10-13, with no change to the public API in that time. From then on, the public API is every name exported by glpi_utils and glpi_utils.oauth that does not start with an underscore. Removing or changing any of those names will need a new major version, and will be preceded by at least one minor release in which the old form emits a DeprecationWarning.

Unit tests run in CI on Python 3.9 to 3.13. Integration tests run both clients, sync and async, against official glpi/glpi containers: the latest patch of GLPI 10.0 (legacy API), 11.0 and 12.0 (legacy API and every High-Level API version the server offers), on every pull request and weekly. GLPI 9.x is not supported.

Contributing

Bug reports with your GLPI version and a traceback are the most useful contribution: open an issue. For code, see the contributing guide.

License

Copyright (C) 2025-2026 Giovanny Rodriguez, Imagunet.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. It is distributed WITHOUT ANY WARRANTY; see the license for details.

Releases up to and including 1.5.0 were published under the MIT License and remain available under it.