{"id":34976826,"url":"https://github.com/apiheat/go-edgegrid","last_synced_at":"2026-05-23T03:02:55.023Z","repository":{"id":33314920,"uuid":"124243478","full_name":"apiheat/go-edgegrid","owner":"apiheat","description":"Akamai edge client","archived":false,"fork":false,"pushed_at":"2021-10-04T07:05:05.000Z","size":5412,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-12-28T12:50:26.457Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/apiheat.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":"2018-03-07T13:55:36.000Z","updated_at":"2021-10-04T07:05:08.000Z","dependencies_parsed_at":"2022-09-12T09:51:35.184Z","dependency_job_id":null,"html_url":"https://github.com/apiheat/go-edgegrid","commit_stats":null,"previous_names":["rafpe/go-edgegrid"],"tags_count":45,"template":false,"template_full_name":null,"purl":"pkg:github/apiheat/go-edgegrid","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiheat%2Fgo-edgegrid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiheat%2Fgo-edgegrid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiheat%2Fgo-edgegrid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiheat%2Fgo-edgegrid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apiheat","download_url":"https://codeload.github.com/apiheat/go-edgegrid/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiheat%2Fgo-edgegrid/sbom","scorecard":{"id":202754,"data":{"date":"2025-08-11","repo":{"name":"github.com/apiheat/go-edgegrid","commit":"667e9da6ac657bf116166385c046952414f91068"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.1,"checks":[{"name":"Code-Review","score":7,"reason":"Found 15/19 approved changesets -- score normalized to 7","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/release.yaml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/apiheat/go-edgegrid/release.yaml/master?enable=pin","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 27 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-16T23:06:39.198Z","repository_id":33314920,"created_at":"2025-08-16T23:06:39.198Z","updated_at":"2025-08-16T23:06:39.198Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33380807,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-23T01:21:08.577Z","status":"online","status_checked_at":"2026-05-23T02:00:05.530Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2025-12-27T00:18:49.439Z","updated_at":"2026-05-23T03:02:49.990Z","avatar_url":"https://github.com/apiheat.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# go-edgegrid\n\nGolang based client for interaction with Akamai API services.\n\n## Step by step using the client\nThe client has been created with simplicity in mind. After several iterations the best approach seems to be allow modularity by seperating credentials/config and services and combining them into `apiClient` object therefore allowing full control of customisation\n\n### Imports\nImport client and all services you plan to use in your code. In example below we import network list service along with client\n```go\nimport (\n\t\"github.com/apiheat/go-edgegrid/v6/edgegrid\"\n\t\n\t// ..... all other services u may also need\n\t\"github.com/apiheat/go-edgegrid/v6/service/netlistv2\"\n)\n```\n\n### Credentials\nCreate new credentials object using on of the below methods:\n* automatically load during config creation. AutoLoad can accept specific section if you do not want to use default \n\t```go\n\tconfig := edgegrid.NewConfig()\n\t\t\t  .WithCredentials(edgegrid.NewCredentials().AutoLoad(\"optional-section-name\"))\n\t\t\t  .WithLogVerbosity(\"debug\")\n\t\t\t  .WithRequestDebug(true)\n\t```\n\n* credentials file ( if section is skipped it uses `default` )\n\t```go\n\tcreds, err := edgegrid.NewCredentials().FromFile(\"/Users/rafpe/.edgerc\").Section(\"sample\")\n\t```\n* JSON string\n\t```go\n\tcreds, err := edgegrid.NewCredentials().FromJSON(`{ \"args\":\"xxx\"}`)\n\t```\n* ENV variables\n\t```go\n\tcreds, err := edgegrid.NewCredentials().FromEnv()\n\t```\n\n### Config\nCreate config object which defines client behaviour. Define options which u require.\n```go\n\tconfig := edgegrid.NewConfig().\n\t\tWithCredentials(creds). \t\t\t\t\t// Required\n\t\tWithLogVerbosity(\"info\").\t\t\t\t\t// Optional\n\t\tWithLocalTesting(true).\t\t\t\t\t\t// Optional\n\t\tWithScheme(\"http\").\t\t\t\t\t\t\t// Optional\n\t\tWithTestingURL(\"http://localhost.test\").\t// Optional\n\t\tWithRequestDebug(true)\t\t\t\t\t\t// Optional\n```\n### Support for Account Switch Key ( manage multiple accounts )\nClient in version starting from `v5.x.x` supports *account switch key* which allows you to manage multiple accounts with single credentials.\n\n* Specify when initialising client\n\n    ```go\n\t// 2 - Config using credentials\n\tconfig := edgegrid.NewConfig().\n\t\tWithCredentials(creds).\n    \tWithAccountSwitchKey(\"1-231-213123\")\n    ```\n\n\nMore information can be found under the following link https://learn.akamai.com/en-us/learn_akamai/getting_started_with_akamai_developers/developer_tools/accountSwitch.html\n\n### Example \nBelow is minimalistic example of all the steps required to get the client running.\n\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/apiheat/go-edgegrid/v6/edgegrid\"\n\t\"github.com/apiheat/go-edgegrid/v6/service/netlistv2\"\n)\n\nfunc main() {\n\n\t// 1 - Credentials - multiple way to obrain credentials\n\tcreds, err := edgegrid.NewCredentials().FromFile(\"/Users/rafpe/.edgerc\").Section(\"sample\")\n\n\t// 2 - Config using credentials\n\tconfig := edgegrid.NewConfig().\n\t\tWithCredentials(creds)\n\n\tlistNetListOptsv2 := netlistv2.ListNetworkListsOptionsv2{}\n\tlistNetListOptsv2.Search = \"\"\n\n\t// 3 - Service using config\n\tapiNetlistv2 := netlistv2.New(config)\n\n\t// 4 - Actions using service\n\tres, err := apiNetlistv2.ListNetworkLists(listNetListOptsv2)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t}\n\n\tfmt.Println(res)\n\n}\n\n```\n\n### Debugging\nThe debug use `WithLogVerbosity(\u003clevel\u003e)` ( *optional* part of config object )  where `\u003clevel\u003e` can be lower case string of `debug` | `warn` |  `info` | `error` | `fatal` | `panic`\n\n\n## Development\n - More info to come \n\n### Tests\n\n- The biggest thing this package still needs is tests :disappointed:\n\n### Issues\n\n- If you have an issue: report it on the [issue tracker](https://github.com/apiheat/go-edgegrid/issues)\n\n\n\n## Authors\n\n* RafPe [https://github.com/rafpe]\n* Petr Artamonov [https://github.com/partamonov/]\n\n## License\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at \u003chttp://www.apache.org/licenses/LICENSE-2.0\u003e\n\n## Inspired by\n* https://github.com/Comcast/go-edgegrid\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapiheat%2Fgo-edgegrid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapiheat%2Fgo-edgegrid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapiheat%2Fgo-edgegrid/lists"}