{"id":15562211,"url":"https://github.com/deanpcmad/porkbunrb","last_synced_at":"2026-02-21T22:03:10.902Z","repository":{"id":242252313,"uuid":"809109321","full_name":"deanpcmad/porkbunrb","owner":"deanpcmad","description":"Ruby wrapper for the Porkbun API","archived":false,"fork":false,"pushed_at":"2024-06-01T18:31:29.000Z","size":25,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-27T18:45:55.193Z","etag":null,"topics":["api-wrapper","porkbun","rubygem"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/deanpcmad.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"buy_me_a_coffee":"deanpcmad"}},"created_at":"2024-06-01T17:57:27.000Z","updated_at":"2024-06-01T19:31:02.000Z","dependencies_parsed_at":"2024-06-01T18:54:41.225Z","dependency_job_id":"5a7636f7-134c-4caf-a846-7d11255fc3aa","html_url":"https://github.com/deanpcmad/porkbunrb","commit_stats":null,"previous_names":["deanpcmad/porkbunrb"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/deanpcmad/porkbunrb","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deanpcmad%2Fporkbunrb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deanpcmad%2Fporkbunrb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deanpcmad%2Fporkbunrb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deanpcmad%2Fporkbunrb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deanpcmad","download_url":"https://codeload.github.com/deanpcmad/porkbunrb/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deanpcmad%2Fporkbunrb/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29694795,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T18:18:25.093Z","status":"ssl_error","status_checked_at":"2026-02-21T18:18:22.435Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["api-wrapper","porkbun","rubygem"],"created_at":"2024-10-02T16:12:22.869Z","updated_at":"2026-02-21T22:03:10.883Z","avatar_url":"https://github.com/deanpcmad.png","language":"Ruby","funding_links":["https://buymeacoffee.com/deanpcmad"],"categories":[],"sub_categories":[],"readme":"# PorkbunRB\n\nPorkbunRB is a Ruby library for the Porkbun API.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem \"porkbunrb\"\n```\n\n## Usage\n\n### Set Client Details\n\nFirstly you'll need to create an API Key \u0026 Secret, which you can generate on the [Porkbun API page](https://porkbun.com/account/api).\nOnce you have these details, you can configure the client with the following:\n\n```ruby\nPorkbun.configure do |config|\n  config.api_key    = ENV[\"PORKBUN_API_KEY\"]\n  config.api_secret = ENV[\"PORKBUN_API_SECRET\"]\nend\n```\n\n### Domains\n\n```ruby\n# Retrieve a list of all domains\n# Returns a Porkbun::Collection\nPorkbun::Domain.list\n#=\u003e #\u003cPorkbun::Collection:0x00 @data=[#\u003cPorkbun::Domain domain=\"deanpcmad.dev\"\u003e]\u003e\n\n# Get name servers for a domain\n# Returns a Porkbun::Collection\nPorkbun::Domain.get(\"deanpcmad.dev\").name_servers\n#=\u003e #\u003cPorkbun::Collection:0x00 @data=[#\u003cPorkbun::NameServer ns=\"ns1.deanpcmad.dev\"\u003e]\u003e\n\n# Get forwards for a domain\n# Returns a Porkbun::Collection\nPorkbun::Domain.get(\"deanpcmad.dev\").forwards\n#=\u003e #\u003cPorkbun::Collection:0x00 @data=[#\u003cPorkbun::Forward record=\"www.deanpcmad.dev\"\u003e]\u003e\n\n# Add a forward\n# Subdomain is optional\n# API Docs: https://porkbun.com/api/json/v3/documentation#Domain%20Add%20URL%20Forward\nPorkbun::Domain.add_forward(\n  domain: \"deanpcmad.dev\",\n  subdomain: \"site\",\n  location: \"https://deanpcmad.com\",\n  type: \"temporary\",\n  include_path: true\n)\n#=\u003e true\n\n# Delete a forward\nPorkbun::Domain.delete(\"deanpcmad.dev\", record: \"123123\")\n#=\u003e true\n```\n\n### Records\n\n```ruby\n# Retrieve a list of all records for a domain\n# Returns a Porkbun::Collection\nPorkbun::Record.list(domain: \"deanpcmad.dev\")\n#=\u003e #\u003cPorkbun::Collection:0x00 @data=[#\u003cPorkbun::Record content=\"pixie.porkbun.com\"\u003e]\u003e\n\n# Retrieve a list of all records for a domain by type\n# Returns a Porkbun::Collection\nPorkbun::Record.list_by_type(domain: \"deanpcmad.dev\", type: \"CNAME\", subdomain: \"*\")\n#=\u003e #\u003cPorkbun::Collection:0x00 @data=[#\u003cPorkbun::Record content=\"pixie.porkbun.com\"\u003e]\u003e\n\n# Get a record\nPorkbun::Record.retrieve(domain: \"deanpcmad.dev\", id: \"123\")\n#=\u003e #\u003cPorkbun::Record content=\"pixie.porkbun.com\"\u003e\n\n# Add a record\n# Name, TTL and Prio are optional\n# API Docs: https://porkbun.com/api/json/v3/documentation#DNS%20Create%20Record\nPorkbun::Domain.add_record(\n  domain: \"deanpcmad.dev\",\n  type: \"A\",\n  value: \"1.2.3.4\",\n  name: \"test\"\n)\n#=\u003e true\n\n# Update a record\nPorkbun::Domain.update_record(\n  domain: \"deanpcmad.dev\",\n  id: \"123123\",\n  type: \"A\",\n  value: \"1.2.3.5\",\n  name: \"test\"\n)\n#=\u003e true\n\n# Delete a record\nPorkbun::Domain.delete_record(\n  domain: \"deanpcmad.dev\",\n  record: \"www.deanpcmad.dev\"\n)\n#=\u003e true\n\n# Delete a record by subdomain and type\nPorkbun::Record.delete_by_subdomain(\n  domain: \"deanpcmad.dev\",\n  type: \"A\",\n  subdomain: \"test\"\n)\n#=\u003e true\n```\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/porkbunrb.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeanpcmad%2Fporkbunrb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeanpcmad%2Fporkbunrb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeanpcmad%2Fporkbunrb/lists"}