{"id":17663845,"url":"https://github.com/marksmurphy/akamai-error-lookup","last_synced_at":"2026-02-20T00:01:36.217Z","repository":{"id":34887984,"uuid":"187252945","full_name":"markSmurphy/akamai-error-lookup","owner":"markSmurphy","description":"Retrieves diagnostic details of Akamai error reference numbers via Akamai's API","archived":false,"fork":false,"pushed_at":"2022-07-08T10:11:24.000Z","size":478,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-13T05:45:34.780Z","etag":null,"topics":["akamai","akamai-cli","cdn","cli","diagnostic-tool","diagnostics","error","hashref","lookup","reference"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/akamai-error-lookup","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/markSmurphy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-17T17:00:01.000Z","updated_at":"2022-02-21T11:26:19.000Z","dependencies_parsed_at":"2022-08-08T02:15:35.729Z","dependency_job_id":null,"html_url":"https://github.com/markSmurphy/akamai-error-lookup","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/markSmurphy/akamai-error-lookup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markSmurphy%2Fakamai-error-lookup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markSmurphy%2Fakamai-error-lookup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markSmurphy%2Fakamai-error-lookup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markSmurphy%2Fakamai-error-lookup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markSmurphy","download_url":"https://codeload.github.com/markSmurphy/akamai-error-lookup/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markSmurphy%2Fakamai-error-lookup/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263376160,"owners_count":23457341,"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":["akamai","akamai-cli","cdn","cli","diagnostic-tool","diagnostics","error","hashref","lookup","reference"],"created_at":"2024-10-23T19:42:42.751Z","updated_at":"2025-10-18T15:57:52.545Z","avatar_url":"https://github.com/markSmurphy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# akamai-error-lookup\n\n![Version](https://img.shields.io/npm/v/akamai-error-lookup?style=plastic)\n![node-current](https://img.shields.io/node/v/akamai-error-lookup?style=plastic)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ad68526459464546ba23686ae1229688)](https://www.codacy.com/gh/markSmurphy/akamai-error-lookup/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=markSmurphy/akamai-error-lookup\u0026amp;utm_campaign=Badge_Grade)\n![GitHub issues](https://img.shields.io/github/issues/markSmurphy/akamai-error-lookup?style=plastic)\n[![Known Vulnerabilities](https://snyk.io/test/npm/akamai-error-lookup/badge.svg)](https://snyk.io/test/npm/akamai-error-lookup)\n![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/akamai-error-lookup?style=plastic)\n![Downloads](https://img.shields.io/npm/dm/akamai-error-lookup?style=plastic)\n![Licence](https://img.shields.io/npm/l/akamai-error-lookup?style=plastic)\n\n## Quick Start\n\n* Install globally using `npm install -g akamai-error-lookup`\n* Configure your Akamai API credentials in `auth.edgerc`\n* Run `hashref [errorReference]`\n\n![Output Example](https://user-images.githubusercontent.com/9842107/58412603-b1d82080-806e-11e9-800f-7e96611538f1.gif)\n\n## Overview\n\n**A command line utility to lookup Akamai error reference numbers (e.g. `Reference #18.2d351ab8.1557333295.a4e16ab`).**\n\nIf you work on a website hosted behind Akamai's CDN you will, on occasion, see an Akamai **Reference #** error number.  These occur when Akamai catches an error, as opposed to the origin serving an error, such as a DNS resolution failure or an origin connection error.\n\nIn these scenarios Akamai reports an error reference number:\n\n![error - Service Unavailable - DNS failure](https://user-images.githubusercontent.com/9842107/57924537-4091b400-789d-11e9-8d04-1be9a9c06bad.png)\n\nUsing `hashref` you can lookup the details of the #Ref error number to diagnose the root cause of the error:\n\n```text\nhashref 11.2e373217.1558103133.1dedf6b\n```\n\n![usage example](https://user-images.githubusercontent.com/9842107/57939351-1ef6f380-78c2-11e9-97f6-27b22aea4ed8.png)\n\n---\n\n## Installation\n\n```text\nnpm install -g akamai-error-lookup\n```\n\n### Configuration\n\nYou'll need to create an `auth.edgerc` file and configure it with your Akamai API credentials as described [here](https://developer.akamai.com/introduction/Conf_Client.html).\n\nYou can save `auth.edgerc` in either the current directory or in the home directory (`node -p require('os').homedir()`).\n\nUsing the home directory means you can install the package globally and call `hashref` from any location.\n\nIf the `auth.edgerc` file is not found you'll receive the following error message:\n\n![auth file not found](https://user-images.githubusercontent.com/9842107/57942716-202c1e80-78ca-11e9-8af6-c13976c22a51.png)\n\n---\n\n## Usage\n\n`hashref [errorReference] [options]`\n\n---\n\n## Options\n\n```text\n--decode \u003ctrue|false\u003e            Enable or disable decoding of URLs and user-agent [true]\n--no-color                       Switches off colour output\n--version                        Display version number\n--help                           Display this help\n```\n\n### decode\n\nBy default all output will be decoded, so that fields such as **user-agent** and **URL** are more readable.  Use `--decode false` to switch this off.\n\n### no-color\n\nIf your terminal has problems rendering the colour output then you can switch it off by using `--no-color`.\n\n### version\n\nPrints out `akamai-error-lookup`'s version number.\n\n### help\n\nDisplays the help screen.\n\n---\n\n## Verbose output\n\nThe default terminal output contains a selective subset of the more salient fields returned by Akamai's API.\n\nThe full `json` response is automatically written to the operating system's default directory for temporary files (`node -p require('os').tmpdir()`).  The location is displayed as part of the terminal output:\n\n```text\nWriting full response to [C:\\Users\\foo\\AppData\\Local\\Temp\\11.2e373217.1558514903.f6c71e.json]\n```\n\nNote: On Linux systems this will be `/tmp` rather than `/var/tmp` which means these files will **not** persist a system reboot.  If you want to retain them, copy them elsewhere.\n\n## Debugging\n\n`akamai-error-lookup` uses the npm package [debug](https://www.npmjs.com/package/debug \"www.npm js.com\").  If you set the environment variable `debug` to `hashref` you'll see full debug output.\n\n### Windows\n\n```text\nset debug=hashref\nhashref [errorReference]\n```\n\n### Linux\n\n```text\nDEBUG=hashref hashref [errorReference]\n```\n\n### Powershell\n\n```text\n$env:debug=\"hashref\"\nnode akamai-error-lookup [errorReference]\n```\n\n---\n\n## Where is the Change Log\n\nThe Change Log as been moved to its own file, `CHANGELOG.md`, and can be found [here](./CHANGELOG.md)\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarksmurphy%2Fakamai-error-lookup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarksmurphy%2Fakamai-error-lookup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarksmurphy%2Fakamai-error-lookup/lists"}