{"id":22394439,"url":"https://github.com/akamai/cli-firewall","last_synced_at":"2025-07-31T10:32:52.756Z","repository":{"id":31453998,"uuid":"124116189","full_name":"akamai/cli-firewall","owner":"akamai","description":"Provides a way to interact with Firewall Rules and Site Shield related information via Open APIs.","archived":false,"fork":false,"pushed_at":"2022-03-07T14:33:14.000Z","size":83,"stargazers_count":16,"open_issues_count":1,"forks_count":9,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-07T00:41:36.722Z","etag":null,"topics":["akamai-cli","cli","firewall","firewall-management","securtity-cli","siteshield"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/akamai.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}},"created_at":"2018-03-06T17:48:01.000Z","updated_at":"2025-02-17T12:10:46.000Z","dependencies_parsed_at":"2022-08-07T16:16:07.052Z","dependency_job_id":null,"html_url":"https://github.com/akamai/cli-firewall","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/akamai/cli-firewall","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akamai%2Fcli-firewall","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akamai%2Fcli-firewall/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akamai%2Fcli-firewall/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akamai%2Fcli-firewall/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akamai","download_url":"https://codeload.github.com/akamai/cli-firewall/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akamai%2Fcli-firewall/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268024655,"owners_count":24183149,"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","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["akamai-cli","cli","firewall","firewall-management","securtity-cli","siteshield"],"created_at":"2024-12-05T05:10:11.093Z","updated_at":"2025-07-31T10:32:52.508Z","avatar_url":"https://github.com/akamai.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cli-firewall\nProvides a way to interact with Firewall Rules and Site Shield related information via Open APIs. Functionality includes viewing firewall rules services, subscribing and unsubscribing to firewall rules services, viewing and acknowledging Site Shield maps, and listing CIDR blocks.\n\n## Local Install\n* Python 3+\n* pip install edgegrid-python\n\n### Credentials\nIn order to use this module, you need to:\n* Set up your credential files as described in the [authorization](https://developer.akamai.com/introduction/Prov_Creds.html) and [credentials](https://developer.akamai.com/introduction/Conf_Client.html) sections of the Get Started pagegetting started guide on developer.akamai.comthe developer portal.  \n* When working through this process you need to give grants for the Firewall Rules Manager and Siteshield API.  For Firewall Rules, the section in your configuration file should be called [firewall]. For Site Shield, the section in your configuration file should be called [site-shield]\n```\n[firewall]\nclient_secret = [CLIENT_SECRET]\nhost = [HOST]\naccess_token = [ACCESS_TOKEN_HERE]\nclient_token = [CLIENT_TOKEN_HERE]\n```\n```\n[site-shield]\nclient_secret = [CLIENT_SECRET]\nhost = [HOST]\naccess_token = [ACCESS_TOKEN_HERE]\nclient_token = [CLIENT_TOKEN_HERE]\n```\n\n## Functionality\nThis version includes the following functionality:\n* List all firewall rules services available for subscription\n* Subscribe and unsubscribe to firewall rules services\n* List CIDRs for all current subscriptions or a specific firewall rules subscribed to\n* List all available Site Shield maps\n* List CIDRs for a specified Site Shield map\n* Acknowledge a pending Site Shield map update\n\n## akamai-firewall\nThis is the main program that wraps this functionality in a command line utility:\n* [list-services](#list-services)\n* [list-subscriptions](#list-subscriptions)\n* [subscribe](#subscribe)\n* [unsubscribe](#unsubscribe)\n* [list-cidrs](#list-cidrs)\n\n## akamai-site-shield\nThis is the main program that wraps this functionality in a command line utility:\n* [list-maps](#list-maps)\n* [list-cidrs](#list-cidrs-1)\n* [acknowledge](#acknowledge)\n\n## Global Flags\n- `--edgerc value` — Location of the credentials file (default: \"/Users/username\") [$AKAMAI_EDGERC]\n- `--section value` — Section of the credentials file (default: \"firewall\" default: \"site-shield\") [$AKAMAI_EDGERC_SECTION]\n- `--help`, `-h` — show help\n- `--version`, `-v` — print the version\n\n```bash\n%  akamai firewall --section section list-services\n%  akamai site-shield --section section list-maps\n```\n\nakamai fw can also be used as alias for akamai firewall\nakamai ss can also be used as alias for akamai site-shield\n\n### list-services\nList available firewall rules services available for subscription. A service must be subscribed to before CIDRs can be displayed for that service.\n\n```bash\n%  akamai firewall list-services\n```\n\n\n### list-subscriptions\nList current subscriptions.\n\n```bash\n%  akamai firewall list-subscriptions\n```\n\n\n### subscribe\nSubscribe to a firewall rules service (email address is mandatory).\n\n```bash\n%  akamai firewall subscribe --service-id 1 --email email@example.com\n%  akamai firewall subscribe --service-name FIRSTPOINT --email email@example.com\n```\n\nThe flags of interest are (please specify either --service-name or --service-id):\n\n```\n--service-id \u003cvalue\u003e            ID of service to be subscribed for\n--service-name \u003cvalue\u003e          Name of service to be subscribed for\n--email \u003cvalue\u003e                 Email address to subscribe for service specified\n```\n\n\n### unsubscribe\nUnsubscribe from a specific firewall rules service.\n\n```bash\n%  akamai firewall unsubscribe --service-id 1\n%  akamai firewall unsubscribe --service-name FIRSTPOINT\n```\n\nThe flags of interest are (please specify either --service-name or --service-id):\n\n```\n--service-id \u003cvalue\u003e            ID of service to be unsubscribed from\n--service-name \u003cvalue\u003e          Name of service to be unsubscribed from\n--email \u003cvalue\u003e                 Email address to unsubscribe for service specified\n```\n\n\n### list-cidrs\nList the CIDR blocks for all current subscriptions or a specific firewall rules service subscription.\n\n```bash\n%  akamai firewall list-cidrs\n%  akamai firewall list-cidrs --file\n%  akamai firewall list-cidrs --service-name FIRSTPOINT\n%  akamai firewall list-cidrs --service-id 20\n%  akamai firewall list-cidrs --service-name 'Global Traffic Management - Siteshield' --json\n```\n\nThe flags of interest are:\n\n```\n--service-id \u003cvalue\u003e            ID of service to be unsubscribed from (optional)\n--service-name \u003cvalue\u003e          Name of service to be unsubscribed from (optional)\n--json                          Display output in json format (optional)\n```\n\n\n### list-maps\nList available Site Shield maps.\n\n```bash\n%  akamai site-shield list-maps\n```\n\n\n### list-cidrs\nList the CIDRs for a specified Site Shield map\n\n```bash\n%  akamai site-shield list-cidrs --map-id 12345\n%  akamai site-shield list-cidrs --map-name sample.akamaiedge.net\n%  akamai site-shield list-cidrs --map-name sample.akamaiedge.net --json\n```\n\nThe flags of interest are (please specify either --map-id or --map-name):\n\n```\n--map-id \u003cvalue\u003e            \tID of desired Site Shield map\n--map-name \u003cvalue\u003e          \tName of desired Site Shield map\n--json                        Display output in json format (optional)\n```\n\n\n### acknowledge\nAcknowledge a pending Site Shield map update.\n\n```bash\n%  akamai site-shield acknowledge --map-id 12345\n%  akamai site-shield acknowledge --map-name sample.akamaiedge.net\n```\n\nThe flags of interest are (please specify either --map-id or --map-name):\n\n```\n--map-id \u003cvalue\u003e            \tID of desired Site Shield map\n--map-name \u003cvalue\u003e          \tName of desired Site Shield map\n```\n\n# Contribution\n\nBy submitting a contribution (the “Contribution”) to this project, and for good and valuable consideration, the receipt and sufficiency of which are hereby acknowledged, you (the “Assignor”) irrevocably convey, transfer, and assign the Contribution to the owner of the repository (the “Assignee”), and the Assignee hereby accepts, all of your right, title, and interest in and to the Contribution along with all associated copyrights, copyright registrations, and/or applications for registration and all issuances, extensions and renewals thereof (collectively, the “Assigned Copyrights”). You also assign all of your rights of any kind whatsoever accruing under the Assigned Copyrights provided by applicable law of any jurisdiction, by international treaties and conventions and otherwise throughout the world.\n\n# Notice\n\nCopyright 2020 – Akamai Technologies, Inc.\nAll works contained in this repository, excepting those explicitly otherwise labeled, are the property of Akamai Technologies, Inc.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakamai%2Fcli-firewall","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakamai%2Fcli-firewall","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakamai%2Fcli-firewall/lists"}