{"id":17256644,"url":"https://github.com/princemaple/elixir-cloudflare-api-client","last_synced_at":"2025-04-14T06:09:19.634Z","repository":{"id":54563976,"uuid":"337367981","full_name":"princemaple/elixir-cloudflare-api-client","owner":"princemaple","description":"Cloudflare API Client for Elixir community","archived":false,"fork":false,"pushed_at":"2022-02-06T00:45:14.000Z","size":146,"stargazers_count":7,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-14T06:09:17.281Z","etag":null,"topics":["api-client","cloudflare","elixir","rest-api"],"latest_commit_sha":null,"homepage":"https://hex.pm/packages/cloudflare","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/princemaple.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2021-02-09T10:28:45.000Z","updated_at":"2024-02-13T04:56:16.000Z","dependencies_parsed_at":"2022-08-13T19:50:35.138Z","dependency_job_id":null,"html_url":"https://github.com/princemaple/elixir-cloudflare-api-client","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/princemaple%2Felixir-cloudflare-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/princemaple%2Felixir-cloudflare-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/princemaple%2Felixir-cloudflare-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/princemaple%2Felixir-cloudflare-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/princemaple","download_url":"https://codeload.github.com/princemaple/elixir-cloudflare-api-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248830395,"owners_count":21168272,"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-client","cloudflare","elixir","rest-api"],"created_at":"2024-10-15T07:14:59.105Z","updated_at":"2025-04-14T06:09:19.601Z","avatar_url":"https://github.com/princemaple.png","language":"Elixir","readme":"# Cloudflare\n\n[![hex.pm](https://img.shields.io/hexpm/v/cloudflare.svg)](https://hex.pm/packages/cloudflare)\n[![hex.pm](https://img.shields.io/hexpm/l/cloudflare.svg)](https://hex.pm/packages/cloudflare)\n[![github.com](https://img.shields.io/github/last-commit/princemaple/elixir-cloudflare-api-client.svg)](https://github.com/princemaple/elixir-cloudflare-api-client)\n\n`Cloudflare` API Client. Written for the Elixir community,\nbased on [`:restlax`](https://github.com/princemaple/restlax).\n\n## Installation\n\nIf [available in Hex](https://hex.pm/docs/publish), the package can be installed\nby adding `cloudflare` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:cloudflare, \"~\u003e 0.2\"}\n  ]\nend\n```\n\n## Configuration\n\n### Authentication\n\n```elixir\nconfig :cloudflare,\n  auth_token: \"my-auth-token\"\n```\n\nOr\n\n```elixir\nconfig :cloudflare,\n  auth_email: \"my@email.com\",\n  auth_key: \"my-auth-key\"\n```\n\nOr both `¯\\(°_o)/¯`.\n\n#### Or passed in\n\n```elixir\nCloudflare.Zone.index(opts: [auth_token: \"my-auth-token\"])\n```\n\n```elixir\nCloudflare.Zone.index(opts: [auth_email: \"my@email.com\", auth_key: \"my-auth-key\"])\n```\n\nOr directly as header\n\n```elixir\nCloudflare.Zone.index(headers: [{\"Authorization\", \"Bearer my-auth-token\"}])\n```\n\n```elixir\nCloudflare.Zone.index(headers: [{\"X-Auth-Email\", \"my@email.com\"}, {\"X-Auth-Key\", \"my-auth-key\"}])\n```\n\n### Register client\n\nNormally it's teadius to explicitly pass the client module in.\n\n```elixir\nCloudflare.Zone.index(client: CloudFlare.Client)\n```\n\nIt can be registered on application start, e.g. in `YourApp.Application.start`\n\n```elixir\ndefmodule YourApp.Application do\n  use Application\n\n  def start(_type, _args) do\n    Cloudflare.Client.init() # \u003c- You can add this line\n    children = [\n      {Phoenix.PubSub, name: App.PubSub},\n      App.Repo,\n      AppWeb.Endpoint\n    ]\n\n    opts = [strategy: :one_for_one, name: App.Supervisor]\n    Supervisor.start_link(children, opts)\n  end\n\n  def config_change(changed, _new, removed) do\n    AppWeb.Endpoint.config_change(changed, removed)\n    :ok\n  end\nend\n```\n\n## Usage\n\n```elixir\nCloudflare.Zone.index()\n```\n\n```elixir\nCloudflare.DnsRecord.index(params: [zone_id: \"my-zone-id\"])\n```\n\n```elixir\nCloudflare.DnsRecord.create(\n  %{type: \"A\", name: \"my.domain\", content: \"127.0.0.1\", ttl: 120},\n  params: [zone_id: \"my-zone-id\"]\n)\n```\n\nDocumentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)\nand published on [HexDocs](https://hexdocs.pm). Once published, the docs can\nbe found at [https://hexdocs.pm/cloudflare](https://hexdocs.pm/cloudflare).\n\n## Contribution\n\nHalf manually scraped Cloudflare docs are located in `priv/docs`. Pick an entity and write module for it.\n\nSimple entities can be as easy as `Cloudflare.Account` and `Cloudflare.User`\n\nSome need a little customization like `Cloudflare.DnsRecord`\n\nSome need more `Cloudflare.ZoneSetting`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprincemaple%2Felixir-cloudflare-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprincemaple%2Felixir-cloudflare-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprincemaple%2Felixir-cloudflare-api-client/lists"}