{"id":16769008,"url":"https://github.com/robincher/node-f5-icontrol-client","last_synced_at":"2026-05-10T02:51:42.941Z","repository":{"id":30648447,"uuid":"125629748","full_name":"robincher/node-f5-icontrol-client","owner":"robincher","description":"🚥 F5 iControl Rest API Simplified Node.js Client ","archived":false,"fork":false,"pushed_at":"2024-02-05T06:23:11.000Z","size":469,"stargazers_count":1,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-10T15:14:29.931Z","etag":null,"topics":["f5","icontrol","nodejs","npm-package","rest-api","up-for-grabs","welcome-pr"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/robincher.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,"dei":null}},"created_at":"2018-03-17T13:03:39.000Z","updated_at":"2023-03-05T06:59:15.000Z","dependencies_parsed_at":"2024-02-03T04:23:45.832Z","dependency_job_id":"9f204b12-91c4-4fb9-8329-64b98e347897","html_url":"https://github.com/robincher/node-f5-icontrol-client","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robincher%2Fnode-f5-icontrol-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robincher%2Fnode-f5-icontrol-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robincher%2Fnode-f5-icontrol-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robincher%2Fnode-f5-icontrol-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robincher","download_url":"https://codeload.github.com/robincher/node-f5-icontrol-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247301552,"owners_count":20916534,"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":["f5","icontrol","nodejs","npm-package","rest-api","up-for-grabs","welcome-pr"],"created_at":"2024-10-13T06:13:06.247Z","updated_at":"2026-05-10T02:51:42.906Z","avatar_url":"https://github.com/robincher.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Node.js library for F5 iControl API\n\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b5ded2e9f9d949a1a9718caf5e3038ea)](https://app.codacy.com/app/robincher/node-f5-icontrol-client?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=robincher/node-f5-icontrol-client\u0026utm_campaign=badger)\n[![Codeship Status for robincher/node-f5-icontrol-client](https://app.codeship.com/projects/4741fed0-0c23-0136-744c-56d424be27fe/status?branch=master)](https://app.codeship.com/projects/281946)\n[![Known Vulnerabilities](https://snyk.io/test/github/robincher/node-f5-icontrol-client/badge.svg?targetFile=package.json)](https://snyk.io/test/github/robincher/node-f5-icontrol-client?targetFile=package.json)\n[![Coverage Status](https://coveralls.io/repos/github/robincher/node-f5-icontrol-client/badge.svg?branch=master)](https://coveralls.io/github/robincher/node-f5-icontrol-client?branch=master)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)\n\nA helper client to interact with F5 iControl APIs.\n\nSee F5 iControl REST API documentation for more details\n\nhttps://devcentral.f5.com/d/icontrol-rest-user-guide\n\n## Getting Started\n\n### Create iControl Client Instance\n\n```\nconst iControl = require('node-icontrol-client').IControlUtil;\n\nlet iControlClient = new iControl({\n  host: '127.0.0.1',\n  proto: 'https',\n  port: 443,\n  token: 'token value', //Authorization Token for Basic Auth\n  output: false //Set to true if you want to see output\n});\n\n\niControlClient.list('/mgmt/tm/net/bwc/policy').then(function(res)  {\n     //Do Something\n    })\n    .catch((err) =\u003e {\n     //Do Something\n    })\n\n\n```\n\n- host : F5's hostname\n- proto : (Optional) Protocol, either https or http. It will be default to https if not specify\n- port: (Optional) TCP/IP port. Default to 443 if not indicated\n- ca : CA file content, required if strict mode is set on.\n- token: F5 generated basic token. Please refer  [here](https://devcentral.f5.com/wiki/iControl.Authentication_with_the_F5_REST_API.ashx) on how you can generate a basic auth token.\n- output : Set it true to print out console logs\n\n### Local Live Testing\n\nRefer to the examples shared within repository.\n\nPlease ensure you have access to a test or development F5 Proxy. You can specify your own testing environment\nA sample.json has been included to help you kick start the testing\n\nRunning the example file\n\n```\ncd example/\n\nnode filename.js\n```\n\n### Unit Testing\n\nRun the following to start unit test\n\n```\nnpm test\n```\n\n### Test Coverage\n\nRun the following to check out the code coverage\n\n```\nnpm run testCoverage\n```\n\n### License\n\nRelease under [GNU GENERAL PUBLIC LICENSE](https://github.com/robincher/node-f5-icontrol-client/blob/master/LICENSE)\n\n## References\n+ [Node iControl Package](https://github.com/thwi/node-icontrol)\n+ [F5 iControl REST API](https://devcentral.f5.com/d/icontrol-rest-user-guide)\n+ [Code Coverage with Codeship CI](https://cdaringe.com/node-js-project-coverage-with-coveralls-io/)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobincher%2Fnode-f5-icontrol-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobincher%2Fnode-f5-icontrol-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobincher%2Fnode-f5-icontrol-client/lists"}