Python client for Cloudflare API v4
Require Python 3.9+
pip install cloudflare-api
Sample code can be found inside /test.py
git clone https://github.com/nikhiljohn10/cloudflare-api
cd cloudflare-api
- Go to Dashboard
- Create Token
- Use
Edit Cloudflare Workers
template - Select one account from Account Resources
- Select
All Zones
or specific zones under Zone Resources - Continue to summary
- Create Token
- Copy the token and save it somewhere secret & secure.
Then run the following command in terminal:
make init
. venv/bin/activate
make test
If it is running for first time, you will be asked to enter API Token. Paste the api token copied from Dashboard.
For this example, poetry
is used for easy setup.
python3 -m pip install --user poetry
mkdir -p myapp && cd myapp
poetry init -n
poetry add cloudflare-api
Copy the code below in to a new file ./myapp/app.py
.
#!/usr/bin/env python3
from CloudflareAPI import Cloudflare
def main():
cf = Cloudflare()
print(cf.account.list())
print(cf.user.details())
print(cf.worker.list())
print(cf.store.list())
if __name__ == "__main__":
main()
You can now run the program using following command:
poetry run python app.py
If it is running for first time, you will be asked to enter API Token. Paste the api token copied from Dashboard. This will create cf-config.ini
file in your current working directory for future reference of the api token.
You can find more examples in examples
directory
1. Account
- Workers Tail ( Read )
- Workers KV Storage ( Edit )
- Workers Scripts ( Edit )
- Account Settings ( Read )
2. Zones
- Workers Routes ( Edit )
3. Users
- User Details ( Read )
-
list
- List all accounts where given token have access -
get_id
- Return account id if only one account exists. Otherwise display all accounts availabe and exit. -
details
- Display details of an account -
rename
* - Rename an existing account
-
details
- Display details of the account's user
-
list
- List all existing workers -
upload
- Upload a new worker with binding if given- Upload file along as javascript
- Upload file along with metadata as multipart form-data
- KV Bindings
- Environment variables
- Secrets
-
download
- Download an existing worker -
deploy
- Deploy an existing worker using the subdomain -
undeploy
- Undeploy an existing worker -
delete
- Delete an existing workercreate
- Create a new subdomain if none existsget
- Get the current subdomain from cloudflare account
update
- Update an existing cron or create new cron for a workerget
- Get the cron task list of specified worker
-
list
- List all existing Namespaces -
get_ns
- Returns requested Namespace object -
create
- Create a new namespace -
rename
- Rename an existing namespace -
delete
- Delete an existing namespace-
keys
- Display all the keys in the Namespace -
read
- Read the value of given key in the Namespace -
write
- Write given key-value pair to the Namespace -
bulk_write
- Write given key-value pairs in bulk to the Namespace -
delete
- Delete given key from the Namespace -
bulk_delete
- Delete given keys in bulk from the Namespaceadd
- Add key-value pair with metadata to bundler
-
( * : Not accessable with default Worker permissions )
To display current version:
make version
To bump to new version, where x.y.z is major,minor & patch versions respectively:
make VERSION=x.y.z bump
The above command does the following:
- Update version in
__version__.py
inside package - Create a commit for the above change
- Tag the commit with VERSION
- Push the content in to main branch with tags
- Python publish workflow action activates
- Release the version pushed
- Build python package
- Publish python package in to pypi.org