---
id: openfire-restapi
version: "0.2.0"
license: GPL-3
license_treatment: copyleft
maintenance: abandoned
---

# openfire-restapi — A python client for Openfire's REST API Plugin

License: copyleft · Maintenance: abandoned · Downloads: 80.6K/mo

## What it is and what it does

openfire-restapi is a thin Python wrapper around Openfire's REST API Plugin, allowing developers to script administrative and operational tasks on an Openfire XMPP server. It provides methods to create and manage users, organize groups, control chat rooms, query sessions, send messages, and access system information—all without manually constructing HTTP requests.

The package depends only on requests and installs with minimal friction. However, it has been abandoned since September 2017 and was never widely maintained. It targets Python 3.4–3.6, and there is no evidence of updates for modern Python versions, newer Openfire releases, or changes to the REST API Plugin interface. Use only if you are running a legacy Openfire deployment and can tolerate the risk of incompatibility.

Use it for:

- Automate user provisioning and account management on an Openfire server from a Python application.
- Script bulk operations like creating groups or configuring chat rooms without manual admin panel interaction.
- Integrate Openfire user or session data into a larger Python-based system administration or monitoring tool.
- Query active sessions or send system messages programmatically to an Openfire deployment.
- Build a Python-based admin dashboard or CLI tool that delegates operations to Openfire via its REST API.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

A Python client library for interacting with Openfire's REST API Plugin, enabling programmatic management of users, groups, chat rooms, sessions, messages, and system configuration.

No, unless you are maintaining legacy code already tied to this package. The project is abandoned (last release 2017-09-20, archived repository), targets outdated Python versions (3.4–3.6), and has not been tested against modern Openfire or Python environments. The GPLv3 copyleft license also restricts redistribution. If you need to interact with Openfire, evaluate whether a newer client library exists or consider direct HTTP calls via requests.

## Install

pip install openfire-restapi
uv add openfire-restapi
poetry add openfire-restapi

## Installing openfire-restapi

Before you install: Installation is straightforward with low friction, but the package is abandoned—last release was 2017-09-20 with no commits since. It was only briefly maintained and has not been updated for modern Python or dependency versions.

License in practice: Licensed under GPLv3 (copyleft). Any derivative work or modification must also be released under GPLv3, and you must disclose source code if you distribute it.

Quickstart:

pip install openfire-restapi

import openfire_restapi
# Create a client instance and call methods for users, groups, or chat rooms
# (exact API depends on Openfire REST plugin configuration)

Requires an Openfire server with the REST API Plugin installed and configured; the package itself targets Python 3.4–3.6 and may not work reliably on modern Python versions.

Verify before relying:

- Whether the package works with modern Python versions (3.10+) or Openfire versions released after 2017.
- Current compatibility of the underlying requests dependency with the package's expectations.
- Whether Openfire's REST API Plugin interface has changed since the package's last release.

## Package facts

- License: GPL-3 (copyleft)
- Python support: unspecified
- Install friction: low
- Maintenance: abandoned
- Downloads: 80.6K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

openfire rest api client, openfire python client, openfire user management, openfire chat room api, xmpp server management, openfire session control, openfire messaging api, xmpp, abandoned, legacy

[View on SkillFed](https://skillfed.io/packages/openfire-restapi) · [View on PyPI](https://pypi.org/project/openfire-restapi/)