Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Honeybadger

Honeybadger Projects API

The Projects API from Honeybadger — 21 operation(s) for projects.

Documentation Provider Profile APIs.io OpenAPI GitHub

Honeybadger Projects API is one of 9 APIs that Honeybadger publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Projects. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 26 operations across 21 paths. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://api.honeybadger.io.

26 operations 21 paths 0 schemas 2 DELETE15 GET7 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://api.honeybadger.io/v1
Authentication
HTTP Basic, API Key
Contact
Honeybadger API Docs
Resource Areas
1

Authentication & Security 2

Honeybadger Projects API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). An API key is passed in the header as X-API-Key (ApiKeyAuth). By default, every request must be authenticated.

  • BasicAuth — HTTP Basic auth. Use your personal AUTHTOKEN as the username and leave the password empty: -u AUTHTOKEN:. Required for the Data API (/v2/).
  • ApiKeyAuth — Project API key used by the Reporting API (/v1/).

Paths & Operations 26

Across 21 paths, the API surfaces 26 operations — 2 DELETE, 15 GET, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Projects 26
GET
/v2/projects
List projects
listProjects 1 param → 200
POST
/v2/projects
Create a project
createProject 1 param → 201
GET
/v2/projects/{id}
Get a project
getProject 1 param → 200
PUT
/v2/projects/{id}
Update a project
updateProject 1 param → 200
DELETE
/v2/projects/{id}
Delete a project
deleteProject 1 param → 204
GET
/v2/projects/occurrences
Count error occurrences across all projects
getOccurrencesAcrossProjects → 200
GET
/v2/projects/{id}/occurrences
Count error occurrences for a project
getProjectOccurrences 1 param → 200
GET
/v2/projects/{id}/integrations
List project integrations
listProjectIntegrations 1 param → 200
GET
/v2/projects/{id}/reports/notices_by_class
Error counts grouped by exception class
reportNoticesByClass 1 param → 200
GET
/v2/projects/{id}/reports/notices_by_location
Error counts grouped by location
reportNoticesByLocation 1 param → 200
GET
/v2/projects/{id}/reports/notices_by_user
Error counts grouped by affected user
reportNoticesByUser 1 param → 200
GET
/v2/projects/{id}/reports/notices_per_day
Error counts grouped by day
reportNoticesPerDay 1 param → 200
GET
/v2/projects/{projectId}/faults
List faults
listFaults 1 param → 200
GET
/v2/projects/{projectId}/faults/{faultId}
Get a fault
getFault 2 params → 200
PUT
/v2/projects/{projectId}/faults/{faultId}
Update a fault
updateFault 2 params → 200
DELETE
/v2/projects/{projectId}/faults/{faultId}
Delete a fault
deleteFault 2 params → 204
GET
/v2/projects/{projectId}/faults/summary
Fault summary counts grouped by environment and status
getFaultSummary 1 param → 200
GET
/v2/projects/{projectId}/faults/{faultId}/occurrences
Get occurrence counts for a fault
getFaultOccurrences 2 params → 200
POST
/v2/projects/{projectId}/faults/{faultId}/pause
Pause notifications for a fault
pauseFault 2 params → 200
POST
/v2/projects/{projectId}/faults/{faultId}/unpause
Unpause a fault
unpauseFault 2 params → 200
POST
/v2/projects/{projectId}/faults/unpause
Unpause all faults in a project
unpauseAllFaults 1 param → 200
POST
/v2/projects/{projectId}/faults/resolve
Resolve all faults in a project
resolveAllFaults 1 param → 200
POST
/v2/projects/{projectId}/faults/{faultId}/link
Link a fault to an external issue (GitHub, Pivotal, etc.)
linkFault 2 params → 200
POST
/v2/projects/{projectId}/faults/{faultId}/unlink
Unlink a fault from its external issue
unlinkFault 2 params → 200
GET
/v2/projects/{projectId}/faults/{faultId}/notices
List individual error notices for a fault
listFaultNotices 2 params → 200
GET
/v2/projects/{projectId}/faults/{faultId}/affected_users
List users affected by a fault
listAffectedUsers 2 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeybadger-projects-api-openapi.yml Raw ↑

Other APIs Honeybadger publishes across the network.

Honeybadger Reporting API
AE Profile APIs.io
Honeybadger Data API
AE Profile APIs.io
Honeybadger Outbound Webhook Notifications
AE Profile APIs.io
Honeybadger Check In API
AE Profile APIs.io
Honeybadger Deploys API
AE Profile APIs.io
Honeybadger Events API
AE Profile APIs.io
Honeybadger Notices API
AE Profile APIs.io
Honeybadger Source Maps API
AE Profile APIs.io
#Projects
← Back to H APIs
API Details
ID
honeybadger:honeybadger-projects-api
Base URL
https://api.honeybadger.io/v1
Docs
https://docs.honeybadger.io/api/
Provider
Honeybadger
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network