f5-icontrol-rest
F5 BIG-IP iControl REST API client
Decision gist · record as of 2026-08-14
No. The package is archived and explicitly superseded by the F5 SDK. Unless you are maintaining legacy code that already uses it, you should use the F5 SDK instead. The lack of maintenance since 2019 means bugs and compatibility issues will not be fixed, and there is no path forward for new features or Python version support.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires network access to a BIG-IP device with iControl REST API enabled; no Python version guarantee due to unmaintained status.
- High install friction due to the package being archived and no longer maintained since 2019.
- The description explicitly directs users to the F5 SDK instead.
License · maintenance · safety
Apache License, Version 2.0 (permissive) — Licensed under Apache License, Version 2.0 (permissive). You may use, modify, and distribute the package freely provided you include the license notice and disclaim warranties.
last release 2019-04-10 (2683 days) · last repo commit 2026-04-13 · 40 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 182,432 downloads/mo, #10,099 on PyPI
Alternatives
Verify before relying
pip install f5-icontrol-rest
from icontrol.session import iControlRESTSession
icr_session = iControlRESTSession('myuser', 'mypass')
icr_session.get('https://bigip.example.com/mgmt/tm/ltm/nat', name='mynat', partition='Common')- Whether this package works with current BIG-IP API versions despite being unmaintained since 2019
- Compatibility with modern Python versions (python_support unspecified in metadata)
- Whether the F5 SDK mentioned in the description is a direct replacement or requires code changes
What it is and what it does
f5-icontrol-rest is a low-level Python client for the F5 BIG-IP iControl REST API. It wraps HTTP requests to BIG-IP management endpoints, allowing you to query and configure network devices programmatically through REST calls. The library provides an iControlRESTSession class that handles authentication and request formatting to interact with BIG-IP resources like NATs, pools, and virtual servers.
However, this package is archived and no longer maintained. The project's own documentation explicitly recommends using the F5 SDK instead for new work. The last release was in 2019, and while the repository shows recent commit activity, the package itself receives no active development. Installation carries high friction because you are adopting an unmaintained dependency for a critical infrastructure tool.
Use it for
- Legacy automation scripts that already depend on this library and cannot be migrated to the F5 SDK
- Read-only queries against BIG-IP devices in environments where the F5 SDK is not available
- Reverse-engineering or understanding how the iControl REST API works at the HTTP level
- Maintaining existing infrastructure code that predates the F5 SDK recommendation
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
No.
The package is archived and explicitly superseded by the F5 SDK. Unless you are maintaining legacy code that already uses it, you should use the F5 SDK instead. The lack of maintenance since 2019 means bugs and compatibility issues will not be fixed, and there is no path forward for new features or Python version support.
Install
f5-icontrol-rest on PyPI
Before you install
High install friction due to the package being archived and no longer maintained since 2019. The description explicitly directs users to the F5 SDK instead. No runtime dependencies, but the lack of active maintenance is a significant concern for new projects.
Requires network access to a BIG-IP device with iControl REST API enabled; no Python version guarantee due to unmaintained status.
License in practice
Licensed under Apache License, Version 2.0 (permissive). You may use, modify, and distribute the package freely provided you include the license notice and disclaim warranties.
Quickstart
pip install f5-icontrol-rest
from icontrol.session import iControlRESTSession
icr_session = iControlRESTSession('myuser', 'mypass')
icr_session.get('https://bigip.example.com/mgmt/tm/ltm/nat', name='mynat', partition='Common')Verify before relying
- Whether this package works with current BIG-IP API versions despite being unmaintained since 2019
- Compatibility with modern Python versions (python_support unspecified in metadata)
- Whether the F5 SDK mentioned in the description is a direct replacement or requires code changes
Package facts
| License | Apache License, Version 2.0 permissive |
| Python support | Not specified |
| Install friction | High. Source build required |
| Runtime dependencies | None |
| Maintenance | Actively maintained 2,683 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 182,432 / month, #10,099 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableIntended Audience :: System AdministratorsLicense :: OSI Approved :: Apache Software LicenseOperating System :: OS IndependentProgramming Language :: Python |
Evidence: f5-icontrol-rest-1.3.13.tar.gz
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “F5 BIG-IP REST API client”
- f5-icontrol-restA REST API client library for interacting with F5 BIG-IP iControl…
- rest.connectorProvides REST API connectivity for network testing and automation,…
- simple-rest-clientA lightweight HTTP client library for building REST API clients in…
Give your agent the search over MCP, or paste the wish link into any chat.
More Internet packages
Botocore provides low-level, data-driven access to Amazon Web Services APIs, serving as the foundation for the AWS CLI and boto3 libraries.
Install it if you need programmatic access to AWS services.
Provides an async client for AWS services using botocore and aiohttp, allowing you to call AWS APIs asynchronously within asyncio-based applications.
Install it if you need to call AWS services from async Python code; it is the standard way to do so.
Pydantic validates Python data structures against type hints, coercing and checking input at runtime to ensure it matches a declared schema.
Provides a platform-independent file locking mechanism to coordinate access to files across processes and threads.
FastAPI is a Python web framework for building REST APIs using type hints, with automatic request validation, serialization, and interactive API documentation.
Provides common Protocol Buffer message definitions used across Google Cloud APIs, enabling Python clients to interact with Google services.
See also rest.connector · aiopnsense · legit-api-client · coreapi · python-mistralclient · snowflake-cli-labs · wafw00f · mwclient · munge