Minimum Version Required: 26.01
Pre-Conditions
Access to the client application, web browser, or API testing tool (e.g., Postman) where the error is occurring.
Administrative or developer access to the server environment, file system, or deployment platform (if applicable).
Access to server logs, reverse proxy logs, or browser developer tools (Network tab).
Knowledge of the expected file paths, API routes, and deployment locations for the requested resources.
Steps
Verify the URL and Path: Check the exact API route or resource path requested. Ensure there are no typos, extra spaces, or missing trailing slashes in the URL.
Check for Renamed or Deleted Resources: Verify if the target resource (file, page, or API endpoint) has been permanently deleted, moved, or renamed in a recent update.
Validate Case Sensitivity: Compare the requested file path against the host operating system's directory structure. Ensure the casing matches exactly, as many operating systems (like Linux) are strictly case-sensitive.
Verify Asset Deployment: Check the server-side file location to confirm that the required static assets or files were successfully deployed and are not missing from the expected directory.
Review Reverse Proxy Configurations: If a reverse proxy is in use, inspect the path rewrite rules and routing configurations to ensure there is no mismatch between the requested path and the destination path on the internal server.
Contact Support: If the issue persists after completing the steps above, please contact support. To ensure efficient troubleshooting, gather and provide the following information:
Exact error messages or codes encountered (including the full URL returning the 404).
Screenshots or video recordings of the issue (e.g., showing the browser's Network tab or API testing tool).
Log files (specifically server access logs, error logs, or reverse proxy logs).
The exact steps taken by the customer that led to the issue.
The date and time the issue was first observed and any recurrence.
Any changes made to the system, codebase, or server configuration before the issue appeared.
Fields And Definitions
404 Not Found: An HTTP standard response code indicating that the client was able to communicate with the server, but the server could not find the requested resource.
API Route: The specific URL or endpoint designated for a particular API function or service.
Reverse Proxy: A server that sits in front of one or more web servers, intercepting client requests and forwarding them to the appropriate backend server based on configured rules.
Path Rewrite Rules: Configurations used by web servers or proxies to automatically modify the URL path of an incoming request before routing it to its final destination.
Static Asset: Files (such as images, CSS, HTML, or JavaScript) that are sent to the client exactly as they are stored on the server, without requiring dynamic generation.
Host Operating System: The underlying operating system running on the server where the application or website is hosted.
Best Practices
Implement Standardized Naming Conventions: Adopt strict, lowercase naming conventions for files and directories to avoid case-sensitivity mismatches across different operating systems.
Automate Link and Route Testing: Utilize automated testing pipelines during deployment to verify that all critical API routes and static assets return a 200 OK status before releasing to production.
Maintain Change Logs: Keep detailed records of any architectural changes, including renamed endpoints or deleted files, and ensure frontend applications are updated concurrently.
Document Proxy Rules: Maintain clear, up-to-date documentation for all reverse proxy configurations and rewrite rules to streamline troubleshooting when routing issues arise.
Use Custom 404 Pages: Implement a custom 404 error page to guide end-users back to active areas of your application if they happen to request a broken or outdated link.