CINXE.COM
Honeybadger API Documentation - Honeybadger Documentation
<!DOCTYPE html> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no"> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> <title>Honeybadger API Documentation - Honeybadger Documentation</title> <meta name="description" content="Honeybadger provides exception and uptime monitoring to keep your web apps error-free."> <meta itemprop="name" content="Honeybadger API Documentation"> <meta itemprop="description" content="Honeybadger provides exception and uptime monitoring to keep your web apps error-free."> <meta itemprop="image" content="https://docs.honeybadger.io/images/pull_image.jpg"> <meta name="twitter:card" content="summary_large_image"> <meta name="twitter:site" content="Honeybadger Documentation"> <meta name="twitter:url" content="https://docs.honeybadger.io/api/"> <meta name="twitter:title" content="Honeybadger API Documentation"> <meta name="twitter:description" content="Honeybadger provides exception and uptime monitoring to keep your web apps error-free."> <meta name="twitter:image" content="https://docs.honeybadger.io/images/pull_image.jpg"> <meta property="og:url" content="https://docs.honeybadger.io/api/"> <meta property="og:type" content="website"> <meta property="og:title" content="Honeybadger API Documentation"> <meta property="og:image" content="https://docs.honeybadger.io/images/pull_image.jpg"> <meta property="og:description" content="Honeybadger provides exception and uptime monitoring to keep your web apps error-free."> <meta property="og:site_name" content="Honeybadger Documentation"> <meta property="og:locale" content="en_US"> <link rel="separator" href="-"> <link rel="preconnect" href="https://fonts.gstatic.com"> <link href="https://fonts.googleapis.com/css2?family=Lato:wght@400;700;900" rel="stylesheet"> <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"> <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32-3e5c50a5.png"> <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16-99592a0d.png"> <link rel="icon" type="image/svg+xml" href="/favicon-52e569f1.svg"> <link color="#EA5937" type="image/png" href="/favicon-52e569f1.svg" rel="mask-icon"> <link rel="manifest" href="/site.webmanifest"> <link href="/style-9ee99eb1.css" rel="stylesheet"> <script src="/site.min-0d126f70.js"></script> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@algolia/algoliasearch-netlify-frontend@1.0.7/dist/algoliasearchNetlify.css"> <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@algolia/algoliasearch-netlify-frontend@1.0.7/dist/algoliasearchNetlify.js"></script> <script src="https://cdn.usefathom.com/script.js" data-site="HVGCVOJS" defer></script> </head> <body data-controller="algolia" class="api api_index"> <div class="root"> <nav> <a class="navbar-brand" href="/"> <img src="/images/navbar_logo-a208e0e8.svg" height="35"> </a> <div class="navbar-links"> <div class="nav-item"> <a href="https://www.honeybadger.io/">Product tour</a> </div> <div class="nav-item"> <a href="https://www.honeybadger.io/plans/">Pricing</a> </div> <div class="nav-item"> <a href="https://www.honeybadger.io/blog/">Blog</a> </div> <div class="nav-item active"> <a href="/">Docs</a> </div> <div class="nav-item"> <a href="https://status.honeybadger.io">Status</a> </div> <div class="nav-item "> <a href="https://www.honeybadger.io/contact/">Contact</a> </div> <div class="nav-item"> <a href="https://www.honeybadger.io/about/">Meet the 'Badgers</a> </div> </div> <div class="navbar-next-steps"> <div class="nav-item"> <a class="cta-nav" href="https://app.honeybadger.io/users/sign_up?plan_id=30252" oncdivck="window.fathom.trackGoal('YDVASYAU', 3900);">Start free trial</a> </div> <div class="nav-item"> <a href="https://app.honeybadger.io/users/sign_in">Log In</a> </div> </div> </nav> <article data-controller="swappable-content toggle" data-toggle-class-value="expanded" data-toggle-target="content"> <aside class="sidebar" data-swappable-content-target="sidebar"> <div class="sidebar-wrap"> <div class="mobile-header"> <div class="small-logo"> <svg width="26" height="32" viewbox="0 0 26 32" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M7.3527 22.2991L2.82515 17.651C2.24833 17.0557 2.24833 16.0845 2.82515 15.4905L11.9491 6.11732C12.5288 5.52323 13.4744 5.52323 14.0526 6.11732L14.6604 6.74143L15.9932 5.27814L14.6835 3.93157C13.7576 2.9822 12.2441 2.9822 11.3188 3.93157L0.69544 14.8419C-0.231813 15.7922 -0.231813 17.3478 0.69544 18.3001L6.70065 24.4662L7.3527 22.2991Z" fill="#EA5937"></path> <path d="M25.307 14.8417L19.1313 8.50225L18.4031 10.5877L23.1738 15.4889C23.7553 16.0844 23.7553 17.0556 23.1738 17.6509L14.0527 27.0226C13.4744 27.6167 12.5288 27.6167 11.9491 27.0226L10.933 25.9792L9.59893 27.4406L11.3188 29.2069C12.2441 30.1591 13.7577 30.1591 14.6835 29.2069L25.307 18.2999C26.231 17.3477 26.231 15.7921 25.307 14.8417Z" fill="#EA5937"></path> <path d="M21.3914 0.25L16.166 15.1639C16.0983 15.3603 16.1292 15.579 16.2547 15.7437C16.3679 15.8948 16.5426 15.9827 16.7273 15.9827C16.7431 15.9827 16.7596 15.9827 16.7766 15.9794L19.4847 15.7437L5.29626 31.25L9.29439 17.8839C9.3524 17.689 9.31113 17.4802 9.18874 17.3216C9.07248 17.1753 8.9041 17.0937 8.72488 17.0937C8.70648 17.0937 8.68997 17.0937 8.67606 17.0949L5.81153 17.34L21.3914 0.25Z" fill="#EA5937"></path> </svg> </div> <div class="page-heading"> <p> Honeybadger API Documentation </p> </div> <div class="search-load-area" data-action="click->algolia#toggle"> <svg class="search-icon" width="26" viewbox="0 0 13 12" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M12.2096 11.0968L8.34493 7.23214C8.94464 6.45683 9.26905 5.50889 9.26905 4.51185C9.26905 3.31838 8.80327 2.19932 7.961 1.35555C7.11872 0.511786 5.99668 0.047493 4.80469 0.047493C3.61271 0.047493 2.49067 0.513275 1.64839 1.35555C0.804625 2.19783 0.340332 3.31838 0.340332 4.51185C0.340332 5.70384 0.806114 6.82588 1.64839 7.66816C2.49067 8.51192 3.61122 8.97622 4.80469 8.97622C5.80173 8.97622 6.74818 8.6518 7.52349 8.05358L11.3881 11.9167C11.3995 11.9281 11.4129 11.9371 11.4277 11.9432C11.4425 11.9493 11.4584 11.9525 11.4744 11.9525C11.4905 11.9525 11.5064 11.9493 11.5212 11.9432C11.536 11.9371 11.5494 11.9281 11.5608 11.9167L12.2096 11.2694C12.2209 11.2581 12.2299 11.2446 12.2361 11.2298C12.2422 11.215 12.2453 11.1991 12.2453 11.1831C12.2453 11.1671 12.2422 11.1512 12.2361 11.1364C12.2299 11.1216 12.2209 11.1081 12.2096 11.0968ZM7.16188 6.86904C6.53091 7.49851 5.69459 7.84524 4.80469 7.84524C3.9148 7.84524 3.07847 7.49851 2.44751 6.86904C1.81804 6.23807 1.4713 5.40175 1.4713 4.51185C1.4713 3.62196 1.81804 2.78415 2.44751 2.15467C3.07847 1.5252 3.9148 1.17846 4.80469 1.17846C5.69459 1.17846 6.5324 1.52371 7.16188 2.15467C7.79135 2.78563 8.13808 3.62196 8.13808 4.51185C8.13808 5.40175 7.79135 6.23956 7.16188 6.86904Z" fill="black"></path> </svg> </div> <div class="expand-area" data-action="click->toggle#toggle"> <svg xmlns="http://www.w3.org/2000/svg" fill="none" class="chevron-down" width="36" height="36" viewbox="0 0 24 24" stroke="currentColor" stroke-width="1.5"> <path d="M6 9l6 6 6-6" stroke-linecap="round"></path> </svg> </div> </div> <div class="sidebar-content"> <div class="mobile-nav"> <nav> <a class="navbar-brand" href="/"> <img src="/images/navbar_logo-a208e0e8.svg" height="35"> </a> <div class="navbar-links"> <div class="nav-item"> <a href="https://www.honeybadger.io/">Product tour</a> </div> <div class="nav-item"> <a href="https://www.honeybadger.io/plans/">Pricing</a> </div> <div class="nav-item"> <a href="https://www.honeybadger.io/blog/">Blog</a> </div> <div class="nav-item active"> <a href="/">Docs</a> </div> <div class="nav-item"> <a href="https://status.honeybadger.io">Status</a> </div> <div class="nav-item "> <a href="https://www.honeybadger.io/contact/">Contact</a> </div> <div class="nav-item"> <a href="https://www.honeybadger.io/about/">Meet the 'Badgers</a> </div> </div> <div class="navbar-next-steps"> <div class="nav-item"> <a class="cta-nav" href="https://app.honeybadger.io/users/sign_up?plan_id=30252" oncdivck="window.fathom.trackGoal('YDVASYAU', 3900);">Start free trial</a> </div> <div class="nav-item"> <a href="https://app.honeybadger.io/users/sign_in">Log In</a> </div> </div> </nav> </div> <script type="text/javascript"> algoliasearchNetlify({ appId: '45WOLCZTZ8', apiKey: 'cb553df02fd5e20d863e861d60f0a091', siteId: '4c33fb5a-cda6-4933-b26c-6421adc204e3', branch: "master", detached: { mediaQuery: '(max-width: 666px)' }, selector: 'div.search', theme: { mark: '#cb6047', background: 'white', selected: '#ececec', text: 'black', colorSourceIcon: 'gray' } }); </script> <div class="search"></div> <div class="sidebar-groups"> <a class="sidebar-back" href="/"> <svg fill="none" xmlns="http://www.w3.org/2000/svg" width="15" height="15" viewbox="0 0 24 24" stroke="currentColor" stroke-width="2"> <path d="M8 7l-5 5 5 5" stroke-linecap="round"></path> <path d="M14 12H3" stroke-linecap="round" stroke-linejoin="round"></path> </svg> Back to Home </a> <div class="sidebar-items hidden"> <div class="sidebar-item selected toggled"> <div class="root-link"> <a href="/api/" class="toggleable-link"> API Docs </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/getting-started/" class="toggleable-link"> Getting Started </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/getting-started/#glossary" class="toggleable-link">Glossary</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/getting-started/#authentication" class="toggleable-link">Authentication</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/getting-started/#rate-limiting" class="toggleable-link">Rate Limiting</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/getting-started/#format" class="toggleable-link">Format</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/getting-started/#requests-and-responses" class="toggleable-link">Requests and Responses</a> </div> </div> </div> </div> <h2> REPORTING </h2> <div class="sidebar-items "> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/reporting-exceptions/" class="toggleable-link"> Exceptions </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/reporting-exceptions/#sample-payload" class="toggleable-link">Sample Payload</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/reporting-exceptions/#payload-tester" class="toggleable-link">Payload Tester</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <a href="/api/reporting-check-ins/" class="toggleable-link"> Check-Ins </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/reporting-deployments/" class="toggleable-link"> Deployments </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/reporting-deployments/#sending-deployment-notifications-manually" class="toggleable-link">Sending deployment notifications manually</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/reporting-source-maps/" class="toggleable-link"> Source Maps </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/reporting-source-maps/#overview" class="toggleable-link">Overview</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/reporting-source-maps/#response-codes" class="toggleable-link">Response Codes</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/reporting-source-maps/#wildcards" class="toggleable-link">Wildcards</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/reporting-events/" class="toggleable-link"> Events </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/reporting-events/#sample-payloads" class="toggleable-link">Sample Payloads</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/reporting-events/#sending-events-from-log-files-and-other-sources" class="toggleable-link">Sending events from log files and other sources</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/reporting-events/#limits" class="toggleable-link">Limits</a> </div> </div> </div> </div> <h2> DATA API (REST) </h2> <div class="sidebar-items "> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/faults/" class="toggleable-link"> Faults </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/faults/#get-a-fault-list-or-fault-details" class="toggleable-link">Get a fault list or fault details</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/faults/#get-a-count-of-faults" class="toggleable-link">Get a count of faults</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/faults/#update-a-fault" class="toggleable-link">Update a fault</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/faults/#delete-a-fault" class="toggleable-link">Delete a fault</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/faults/#get-a-count-of-occurrences-for-a-fault" class="toggleable-link">Get a count of occurrences for a fault</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/faults/#pausing-and-unpausing-faults" class="toggleable-link">Pausing and unpausing faults</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/faults/#bulk-resolving-faults" class="toggleable-link">Bulk-resolving faults</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/faults/#linking-faults-to-existing-3rd-party-issues" class="toggleable-link">Linking faults to existing 3rd-party issues</a> </div> <div class="sidebar-sub-item level-2"> <a href="/api/faults/#github" class="toggleable-link">GitHub</a> </div> <div class="sidebar-sub-item level-2"> <a href="/api/faults/#jira" class="toggleable-link">Jira</a> </div> <div class="sidebar-sub-item level-2"> <a href="/api/faults/#pivotal-tracker" class="toggleable-link">Pivotal Tracker</a> </div> <div class="sidebar-sub-item level-2"> <a href="/api/faults/#trello" class="toggleable-link">Trello</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/faults/#unlinking-faults" class="toggleable-link">Unlinking faults</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/faults/#get-a-list-of-notices" class="toggleable-link">Get a list of notices</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/faults/#get-a-list-of-affected-users" class="toggleable-link">Get a list of affected users</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/uptime/" class="toggleable-link"> Uptime </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/uptime/#get-a-site-list-or-site-details" class="toggleable-link">Get a site list or site details</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/uptime/#create-a-site" class="toggleable-link">Create a site</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/uptime/#update-a-site" class="toggleable-link">Update a site</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/uptime/#delete-a-site" class="toggleable-link">Delete a site</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/uptime/#get-a-list-of-outages-for-a-site" class="toggleable-link">Get a list of outages for a site</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/uptime/#get-a-list-of-uptime-checks-for-a-site" class="toggleable-link">Get a list of uptime checks for a site</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/check-ins/" class="toggleable-link"> Check-Ins </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/check-ins/#get-a-check-in-list-or-check-in-details" class="toggleable-link">Get a check-in list or check-in details</a> </div> <div class="sidebar-sub-item level-2"> <a href="/api/check-ins/#simple-check-in" class="toggleable-link">Simple check-in</a> </div> <div class="sidebar-sub-item level-2"> <a href="/api/check-ins/#cron-check-in" class="toggleable-link">Cron check-in</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/check-ins/#create-a-check-in" class="toggleable-link">Create a check-in</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/check-ins/#update-a-check-in" class="toggleable-link">Update a check-in</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/check-ins/#update-all-check-ins" class="toggleable-link">Update all check-ins</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/check-ins/#delete-a-check-in" class="toggleable-link">Delete a check-in</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/comments/" class="toggleable-link"> Comments </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/comments/#get-a-comment-list-or-comment-details" class="toggleable-link">Get a comment list or comment details</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/comments/#create-a-comment" class="toggleable-link">Create a comment</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/comments/#update-a-comment" class="toggleable-link">Update a comment</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/comments/#delete-a-comment" class="toggleable-link">Delete a comment</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/deployments/" class="toggleable-link"> Deployments </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/deployments/#get-a-deploy-list-or-deploy-details" class="toggleable-link">Get a deploy list or deploy details</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/deployments/#delete-a-deploy" class="toggleable-link">Delete a deploy</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/projects/" class="toggleable-link"> Projects </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/projects/#get-a-project-list-or-project-details" class="toggleable-link">Get a project list or project details</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/projects/#create-a-project" class="toggleable-link">Create a project</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/projects/#update-a-project" class="toggleable-link">Update a project</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/projects/#delete-a-project" class="toggleable-link">Delete a project</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/projects/#get-a-count-of-occurrences-for-all-projects-or-a-single-project" class="toggleable-link">Get a count of occurrences for all projects or a single project</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/projects/#get-a-list-of-integrations-for-a-project" class="toggleable-link">Get a list of integrations for a project</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/projects/#get-report-data" class="toggleable-link">Get report data</a> </div> <div class="sidebar-sub-item level-2"> <a href="/api/projects/#notices-by-class" class="toggleable-link">Notices by class</a> </div> <div class="sidebar-sub-item level-2"> <a href="/api/projects/#notices-by-location" class="toggleable-link">Notices by location</a> </div> <div class="sidebar-sub-item level-2"> <a href="/api/projects/#notices-by-user" class="toggleable-link">Notices by user</a> </div> <div class="sidebar-sub-item level-2"> <a href="/api/projects/#notices-by-day" class="toggleable-link">Notices by day</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/teams/" class="toggleable-link"> Teams </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/teams/#get-a-team-list-or-team-details" class="toggleable-link">Get a team list or team details</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/teams/#create-a-team" class="toggleable-link">Create a team</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/teams/#update-a-team" class="toggleable-link">Update a team</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/teams/#delete-a-team" class="toggleable-link">Delete a team</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/teams/#get-a-list-of-team-members-or-team-member-details" class="toggleable-link">Get a list of team members or team member details</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/teams/#update-a-team-member" class="toggleable-link">Update a team member</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/teams/#delete-a-team-member" class="toggleable-link">Delete a team member</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/teams/#create-a-team-invitation" class="toggleable-link">Create a team invitation</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/teams/#update-a-team-invitation" class="toggleable-link">Update a team invitation</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/teams/#get-a-team-invitation-list-or-team-invitation-details" class="toggleable-link">Get a team invitation list or team invitation details</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/teams/#delete-a-team-invitation" class="toggleable-link">Delete a team invitation</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/environments/" class="toggleable-link"> Environments </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/environments/#get-all-environments" class="toggleable-link">Get all environments</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/environments/#get-a-single-environment-39-s-details" class="toggleable-link">Get a single environment's details</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/environments/#create-an-environment" class="toggleable-link">Create an environment</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/environments/#update-an-environment" class="toggleable-link">Update an environment</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/environments/#delete-an-environment" class="toggleable-link">Delete an environment</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/accounts/" class="toggleable-link"> Accounts </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/accounts/#get-all-accounts" class="toggleable-link">Get all accounts</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/accounts/#get-info-for-one-account" class="toggleable-link">Get info for one account</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/accounts/#get-a-list-of-account-users-or-user-details" class="toggleable-link">Get a list of account users or user details</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/accounts/#update-a-user" class="toggleable-link">Update a user</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/accounts/#remove-a-user-from-the-account" class="toggleable-link">Remove a user from the account</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/accounts/#create-an-invitation-for-a-user-to-join-an-account" class="toggleable-link">Create an invitation for a user to join an account</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/accounts/#update-an-account-invitation" class="toggleable-link">Update an account invitation</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/accounts/#get-an-account-invitation-list-or-account-invitation-details" class="toggleable-link">Get an account invitation list or account invitation details</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/accounts/#delete-an-account-invitation" class="toggleable-link">Delete an account invitation</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/api/status-pages/" class="toggleable-link"> Status Pages </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/api/status-pages/#get-all-status-pages" class="toggleable-link">Get all status pages</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/status-pages/#get-a-single-status-page-39-s-details" class="toggleable-link">Get a single status page's details</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/status-pages/#create-a-status-page" class="toggleable-link">Create a status page</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/status-pages/#update-a-status-page" class="toggleable-link">Update a status page</a> </div> <div class="sidebar-sub-item level-1"> <a href="/api/status-pages/#delete-a-status-page" class="toggleable-link">Delete a status page</a> </div> </div> </div> </div> </div> </div> </div> </aside> <div class="loader"> <svg width="159" height="185" viewbox="0 0 159 185" fill="none" xmlns="http://www.w3.org/2000/svg"> <g> <g id="edges"> <path d="M140.566 89.0256L109.923 58.3292L106.31 68.4273L129.981 92.159C132.867 95.0427 132.867 99.7451 129.981 102.628L84.7232 148.006C81.8541 150.883 77.1619 150.883 74.2857 148.006L69.2437 142.954L62.6243 150.03L71.158 158.583C75.7495 163.194 83.2594 163.194 87.8532 158.583L140.566 105.77C145.15 101.159 145.15 93.6272 140.566 89.0256Z" fill="#EA5937"></path> <path d="M51.4788 125.134L29.0137 102.628C26.1516 99.7458 26.1516 95.0433 29.0137 92.1667L74.2856 46.7812C77.1618 43.9046 81.8539 43.9046 84.7231 46.7812L87.7385 49.8032L94.352 42.7178L87.8531 36.1977C83.2593 31.6007 75.7494 31.6007 71.1579 36.1977L18.4464 89.0262C13.8455 93.6278 13.8455 101.16 18.4464 105.771L48.2435 135.628L51.4788 125.134Z" fill="#EA5937"></path> </g> <path id="bolt" d="M120.442 19.5L95.223 89.7397C94.8964 90.6647 95.0455 91.6947 95.6509 92.4703C96.1972 93.1821 97.0406 93.5961 97.9317 93.5961C98.008 93.5961 98.0877 93.5961 98.1696 93.5802L111.24 92.4703L42.7635 165.5L62.0592 102.55C62.3392 101.632 62.14 100.649 61.5493 99.9015C60.9882 99.2126 60.1756 98.8282 59.3106 98.8282C59.2219 98.8282 59.1422 98.8282 59.075 98.8339L45.2503 99.9882L120.442 19.5Z" fill="#EA5937"></path> </g> </svg> </div> <div class="content-wrap index-page" data-swappable-content-target="content"> <div class="content " data-page-id="api"> <div class="header-group"> <h1> Honeybadger API Documentation </h1> </div> <div class="content-body"> <div class="content-left"> <div data-controller="config"> <p> Honeybadger's APIs allow you to report exceptions from your applications, monitor your scheduled tasks, and retrieve and update the data we generate from your app's errors. </p> <h2>Reporting</h2> <p> These endpoints are the core of Honeybadger and how you get your data into our system. </p> <div class="cards side-by-side"> <a href="reporting-exceptions" class="card"> <div class="heading"> Exceptions </div> <div class="url"> <code>api.honeybadger.io/v1/notices</code> </div> </a> <a href="reporting-check-ins" class="card"> <div class="heading"> Check-Ins </div> <div class="url"> <code>api.honeybadger.io/v1/check_in/:id</code> </div> </a> <a href="reporting-deployments" class="card"> <div class="heading"> Deployments </div> <div class="url"> <code>api.honeybadger.io/v1/deploys</code> </div> </a> <a href="reporting-source-maps" class="card"> <div class="heading"> Source Maps </div> <div class="url"> <code>api.honeybadger.io/v1/source_maps</code> </div> </a> <a href="reporting-events" class="card"> <div class="heading"> Events </div> <div class="url"> <code>api.honeybadger.io/v1/events</code> </div> </a> </div> <h2>Data API</h2> <p> The Data API can be used to access data stored in your Honeybadger account and to make changes to your account data </p> <div class="cards"> <a href="/api/faults/" class="card"> <div class="heading"> Faults </div> </a><a href="/api/uptime/" class="card"> <div class="heading"> Uptime </div> </a><a href="/api/check-ins/" class="card"> <div class="heading"> Check-Ins </div> </a><a href="/api/comments/" class="card"> <div class="heading"> Comments </div> </a><a href="/api/deployments/" class="card"> <div class="heading"> Deployments </div> </a><a href="/api/projects/" class="card"> <div class="heading"> Projects </div> </a><a href="/api/teams/" class="card"> <div class="heading"> Teams </div> </a><a href="/api/environments/" class="card"> <div class="heading"> Environments </div> </a><a href="/api/accounts/" class="card"> <div class="heading"> Accounts </div> </a><a href="/api/status-pages/" class="card"> <div class="heading"> Status Pages </div> </a> </div> </div> <footer> Copyright <b>2012-2025</b> <a href="https://www.honeybadger.io">Honeybadger.io</a> </footer> </div> </div> </div> </div> </article> </div> </body> </html>