{"id":15715431,"url":"https://github.com/cloudflare/cloudflare-python","last_synced_at":"2025-05-14T09:07:59.964Z","repository":{"id":227780031,"uuid":"753271547","full_name":"cloudflare/cloudflare-python","owner":"cloudflare","description":"The official Python library for the Cloudflare API","archived":false,"fork":false,"pushed_at":"2025-05-13T01:31:36.000Z","size":34782,"stargazers_count":253,"open_issues_count":6,"forks_count":55,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-05-13T01:34:44.668Z","etag":null,"topics":["api","cloudflare","sdk","sdk-python"],"latest_commit_sha":null,"homepage":"https://developers.cloudflare.com/api","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/cloudflare.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-02-05T19:49:12.000Z","updated_at":"2025-05-11T18:40:05.000Z","dependencies_parsed_at":"2024-05-03T06:35:30.376Z","dependency_job_id":"74e8683a-b406-4c63-abfe-dd6cbf7f603e","html_url":"https://github.com/cloudflare/cloudflare-python","commit_stats":null,"previous_names":["cloudflare/cloudflare-python"],"tags_count":54,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudflare%2Fcloudflare-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudflare%2Fcloudflare-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudflare%2Fcloudflare-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudflare%2Fcloudflare-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudflare","download_url":"https://codeload.github.com/cloudflare/cloudflare-python/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254110374,"owners_count":22016391,"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":["api","cloudflare","sdk","sdk-python"],"created_at":"2024-10-03T21:41:34.141Z","updated_at":"2025-05-14T09:07:54.939Z","avatar_url":"https://github.com/cloudflare.png","language":"Python","readme":"# Cloudflare Python API library\n\n[![PyPI version](https://img.shields.io/pypi/v/cloudflare.svg)](https://pypi.org/project/cloudflare/)\n\nThe Cloudflare Python library provides convenient access to the Cloudflare REST API from any Python 3.8+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n## Documentation\n\nThe REST API documentation can be found on [developers.cloudflare.com](https://developers.cloudflare.com/api). The full API of this library can be found in [api.md](api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install cloudflare\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```python\nimport os\nfrom cloudflare import Cloudflare\n\nclient = Cloudflare(\n    api_email=os.environ.get(\"CLOUDFLARE_EMAIL\"),  # This is the default and can be omitted\n    api_key=os.environ.get(\"CLOUDFLARE_API_KEY\"),  # This is the default and can be omitted\n)\n\nzone = client.zones.create(\n    account={\"id\": \"023e105f4ecef8ad9ca31a8372d0c353\"},\n    name=\"example.com\",\n    type=\"full\",\n)\nprint(zone.id)\n```\n\nWhile you can provide a `api_email` keyword argument,\nwe recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)\nto add `CLOUDFLARE_EMAIL=\"user@example.com\"` to your `.env` file\nso that your API Email is not stored in source control.\n\n## Async usage\n\nSimply import `AsyncCloudflare` instead of `Cloudflare` and use `await` with each API call:\n\n```python\nimport os\nimport asyncio\nfrom cloudflare import AsyncCloudflare\n\nclient = AsyncCloudflare(\n    api_email=os.environ.get(\"CLOUDFLARE_EMAIL\"),  # This is the default and can be omitted\n    api_key=os.environ.get(\"CLOUDFLARE_API_KEY\"),  # This is the default and can be omitted\n)\n\n\nasync def main() -\u003e None:\n    zone = await client.zones.create(\n        account={\"id\": \"023e105f4ecef8ad9ca31a8372d0c353\"},\n        name=\"example.com\",\n        type=\"full\",\n    )\n    print(zone.id)\n\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the Cloudflare API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nfrom cloudflare import Cloudflare\n\nclient = Cloudflare()\n\nall_accounts = []\n# Automatically fetches more pages as needed.\nfor account in client.accounts.list():\n    # Do something with account here\n    all_accounts.append(account)\nprint(all_accounts)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nfrom cloudflare import AsyncCloudflare\n\nclient = AsyncCloudflare()\n\n\nasync def main() -\u003e None:\n    all_accounts = []\n    # Iterate through items across all pages, issuing requests as needed.\n    async for account in client.accounts.list():\n        all_accounts.append(account)\n    print(all_accounts)\n\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await client.accounts.list()\nif first_page.has_next_page():\n    print(f\"will fetch next page using these details: {first_page.next_page_info()}\")\n    next_page = await first_page.get_next_page()\n    print(f\"number of items we just fetched: {len(next_page.result)}\")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await client.accounts.list()\nfor account in first_page.result:\n    print(account.id)\n\n# Remove `await` for non-async usage.\n```\n\n## Nested params\n\nNested parameters are dictionaries, typed using `TypedDict`, for example:\n\n```python\nfrom cloudflare import Cloudflare\n\nclient = Cloudflare()\n\naccount = client.accounts.create(\n    name=\"name\",\n    type=\"standard\",\n    unit={\"id\": \"f267e341f3dd4697bd3b9f71dd96247f\"},\n)\nprint(account.unit)\n```\n\n## File uploads\n\nRequest parameters that correspond to file uploads can be passed as `bytes`, a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.\n\n```python\nfrom pathlib import Path\nfrom cloudflare import Cloudflare\n\nclient = Cloudflare()\n\nclient.api_gateway.user_schemas.create(\n    zone_id=\"023e105f4ecef8ad9ca31a8372d0c353\",\n    file=Path(\"/path/to/file\"),\n    kind=\"openapi_v3\",\n)\n```\n\nThe async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `cloudflare.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `cloudflare.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `cloudflare.APIError`.\n\n```python\nimport cloudflare\nfrom cloudflare import Cloudflare\n\nclient = Cloudflare()\n\ntry:\n    client.zones.get(\n        zone_id=\"023e105f4ecef8ad9ca31a8372d0c353\",\n    )\nexcept cloudflare.APIConnectionError as e:\n    print(\"The server could not be reached\")\n    print(e.__cause__)  # an underlying Exception, likely raised within httpx.\nexcept cloudflare.RateLimitError as e:\n    print(\"A 429 status code was received; we should back off a bit.\")\nexcept cloudflare.APIStatusError as e:\n    print(\"Another non-200-range status code was received\")\n    print(e.status_code)\n    print(e.response)\n```\n\nError codes are as follows:\n\n| Status Code | Error Type                 |\n| ----------- | -------------------------- |\n| 400         | `BadRequestError`          |\n| 401         | `AuthenticationError`      |\n| 403         | `PermissionDeniedError`    |\n| 404         | `NotFoundError`            |\n| 422         | `UnprocessableEntityError` |\n| 429         | `RateLimitError`           |\n| \u003e=500       | `InternalServerError`      |\n| N/A         | `APIConnectionError`       |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and \u003e=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom cloudflare import Cloudflare\n\n# Configure the default for all requests:\nclient = Cloudflare(\n    # default is 2\n    max_retries=0,\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries=5).zones.get(\n    zone_id=\"023e105f4ecef8ad9ca31a8372d0c353\",\n)\n```\n\n### Timeouts\n\nBy default requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:\n\n```python\nfrom cloudflare import Cloudflare\n\n# Configure the default for all requests:\nclient = Cloudflare(\n    # 20 seconds (default is 1 minute)\n    timeout=20.0,\n)\n\n# More granular control:\nclient = Cloudflare(\n    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nclient.with_options(timeout=5.0).zones.edit(\n    zone_id=\"023e105f4ecef8ad9ca31a8372d0c353\",\n)\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](#retries).\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `CLOUDFLARE_LOG` to `info`.\n\n```shell\n$ export CLOUDFLARE_LOG=info\n```\n\nOr to `debug` for more verbose logging.\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n  if 'my_field' not in response.model_fields_set:\n    print('Got json like {}, without a \"my_field\" key present at all.')\n  else:\n    print('Got json like {\"my_field\": null}.')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe \"raw\" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom cloudflare import Cloudflare\n\nclient = Cloudflare()\nresponse = client.zones.with_raw_response.create(\n    account={\n        \"id\": \"023e105f4ecef8ad9ca31a8372d0c353\"\n    },\n    name=\"example.com\",\n    type=\"full\",\n)\nprint(response.headers.get('X-My-Header'))\n\nzone = response.parse()  # get the object that `zones.create()` would have returned\nprint(zone.id)\n```\n\nThese methods return an [`APIResponse`](https://github.com/cloudflare/cloudflare-python/tree/main/src/cloudflare/_response.py) object.\n\nThe async client returns an [`AsyncAPIResponse`](https://github.com/cloudflare/cloudflare-python/tree/main/src/cloudflare/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.\n\n```python\nwith client.zones.with_streaming_response.create(\n    account={\"id\": \"023e105f4ecef8ad9ca31a8372d0c353\"},\n    name=\"example.com\",\n    type=\"full\",\n) as response:\n    print(response.headers.get(\"X-My-Header\"))\n\n    for line in response.iter_lines():\n        print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) when making this request.\n\n```py\nimport httpx\n\nresponse = client.post(\n    \"/foo\",\n    cast_to=httpx.Response,\n    body={\"my_param\": True},\n)\n\nprint(response.headers.get(\"x-foo\"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)\n- Custom [transports](https://www.python-httpx.org/advanced/transports/)\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nimport httpx\nfrom cloudflare import Cloudflare, DefaultHttpxClient\n\nclient = Cloudflare(\n    # Or use the `CLOUDFLARE_BASE_URL` env var\n    base_url=\"http://my.test.server.example.com:8083\",\n    http_client=DefaultHttpxClient(\n        proxy=\"http://my.test.proxy.example.com\",\n        transport=httpx.HTTPTransport(local_address=\"0.0.0.0\"),\n    ),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nclient.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n```py\nfrom cloudflare import Cloudflare\n\nwith Cloudflare() as client:\n  # make requests here\n  ...\n\n# HTTP client is now closed\n```\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n1. Changes to library internals which are technically public but not intended or documented for external use. \n1. Changes that we do not expect to impact the vast majority of users in practice.\n\n### Determining the installed version\n\nIf you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport cloudflare\nprint(cloudflare.__version__)\n```\n\n## Requirements\n\nPython 3.8 or higher.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n","funding_links":[],"categories":["Core Platform \u0026 SDKs","Python"],"sub_categories":["Official SDKs"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudflare%2Fcloudflare-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudflare%2Fcloudflare-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudflare%2Fcloudflare-python/lists"}