Python client for the Cloudflare v4 API
Project description
cloudflare-api
Python client for Cloudflare API v4
Usage
Python Package
pip install cloudflare-api
Sample code can be found inside /test.py
Source Code
git clone https://github.com/nikhiljohn10/cloudflare-api
cd cloudflare-api
Create a secret.py
in the root directory with following content:
API_TOKEN = ""
ACCOUNT_ID = ""
The above variable need to be assigned with your own api token and account id from Cloudflare dashboard.
Then run the following command in terminal:
make test
Example
For this example, poetry
is used for easy setup.
python3 -m pip install poetry
poetry new cloudflare-app
cd cloudflare-app
poetry add cloudflare-api
Copy the code below in to a new file ./cloudflare-app/__main__.py
. Then replace API_TOKEN
& ACCOUNT_ID
values with values obtained from Cloudflare dashboard.
#!/usr/bin/env python3
from CloudflareAPI import Cloudflare, jsonPrint
API_TOKEN = ""
ACCOUNT_ID = ""
def main():
cf = Cloudflare(token=API_TOKEN, account_id=ACCOUNT_ID)
print(cf.worker.list())
print(cf.store.list())
Now we can run our program using following command:
poetry run python cloudflare-app
Available endpoints
Account
list
- List all accounts where given token have accessget_id
- Return account id if only one account exists. Otherwise display all accounts availabe and exit.details
- Display details of an accountrename
- Rename an existing account
Worker
-
list
- List all existing workers -
upload
- Upload a new worker with binding if given -
download
- Download an existing worker -
deploy
- Deploy an existing worker using the subdomain -
undeploy
- Undeploy an existing worker -
delete
- Delete an existing workerSubdomain
create
- Create a new subdomain if none existsget
- Get the current subdomain from cloudflare account
Store(Workers KV)
list
- List all existing Namespacesid
- Find the namespace id of the namespacecreate
- Create a new namespacerename
- Rename an existing namespacedelete
- Delete an existing namespace
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cloudflare_api-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aad7fca605c2d446cd2f742762644b211a00c4a8257e0e347111072018d201dd |
|
MD5 | 7d6b98abe480816e4ed22222f8905973 |
|
BLAKE2b-256 | b00dc10d4540d6995b878c79c03f4c8cfece1992609c38fab50f6ef0afb6d9e0 |