Honeybadger API

https://docs.honeybadger.io/api
Admin
Honeybadger's APIs allow you to report exceptions, monitor scheduled tasks, and retrieve and update...
Tokens:37,888
Snippets:147
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get Sites

Source: https://docs.honeybadger.io/api/uptime

Retrieves a list of all sites for a given project or the details of a specific site.

```APIDOC
## GET /v2/projects/{ID}/sites

### Description
Retrieves a list of sites for the specified project or details for a specific site if a site ID is provided.

### Method
GET

### Endpoint
`/v2/projects/{ID}/sites` or `/v2/projects/{ID}/sites/{ID}`

### Parameters
#### Path Parameters
- **ID** (string) - Required - The unique identifier for the project.
- **ID** (string) - Required - The unique identifier for the site (optional, for specific site details).

### Response
#### Success Response (200)
- **active** (boolean) - Indicates if the site check is active.
- **frequency** (integer) - The interval in minutes between checks (1, 5, or 15).
- **id** (string) - The unique identifier for the site.
- **last_checked_at** (string) - The timestamp of the last check.
- **match** (string) - Criteria for a passing check (unused if match_type is 'success').
- **match_type** (string) - Type of match ('success', 'exact', 'include', 'exclude').
- **name** (string) - The name of the site.
- **state** (string) - The current status of the site ('up' or 'down').
- **url** (string) - The URL of the site being monitored.

#### Response Example
```json
{
  "active": true,
  "frequency": 5,
  "id": "9eed6a7e-af77-4cc6-8c55-b7b17555330d",
  "last_checked_at": "2016-06-15T12:57:29.646956Z",
  "match": null,
  "match_type": "success",
  "name": "Main site",
  "state": "down",
  "url": "http://www.example.com"
}
```
```

--------------------------------

### Fetch Projects List using curl

Source: https://docs.honeybadger.io/api/getting-started

This example demonstrates how to retrieve a list of your projects from the Honeybadger API using the curl command-line tool. It utilizes HTTP Basic Authentication with a personal authentication token. Ensure your `AUTH_TOKEN` is replaced with your actual token.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects 
```

--------------------------------

### Get Check-ins

Source: https://docs.honeybadger.io/api/check-ins

Retrieves a list of check-ins or details of a specific check-in for a given project. The response structure varies slightly for simple and cron check-ins.

```APIDOC
## GET /v2/projects/{ID}/check_ins

### Description
Retrieves a list of check-ins or details of a specific check-in for a given project. The response structure varies slightly for simple and cron check-ins.

### Method
GET

### Endpoint
`/v2/projects/{ID}/check_ins` or `/v2/projects/{ID}/check_ins/{ID}`

### Parameters
#### Path Parameters
- **ID** (string) - Required - The unique identifier for the project or check-in.

### Response
#### Success Response (200)
- **state** (string) - The current state of the check-in ('pending', 'reporting', etc.).
- **schedule_type** (string) - The type of check-in ('simple' or 'cron').
- **reported_at** (string) - The timestamp when the check-in was last reported.
- **expected_at** (string) - The timestamp when the check-in is next expected.
- **missed_count** (integer) - The number of times the check-in has been missed.
- **grace_period** (string) - The grace period before a check-in is considered missed.
- **id** (string) - The unique identifier for the check-in.
- **name** (string) - The name of the check-in.
- **slug** (string) - The slug for the check-in URL.
- **url** (string) - The API URL for the check-in.
- **cron_schedule** (string) - (Cron check-ins only) The cron schedule string.
- **cron_timezone** (string) - (Cron check-ins only) The timezone for the cron schedule.

#### Response Example (Simple Check-in)
```json
{
  "state": "pending",
  "schedule_type": "simple",
  "reported_at": null,
  "expected_at": null,
  "missed_count": 0,
  "grace_period": "5 minutes",
  "id": "XXXXXX",
  "name": "Hourly clean up",
  "slug": "hourly-clean-up",
  "url": "https://api.honeybadger.io/v1/check_in/XXXXXX",
  "report_period": "1 hour"
}
```

#### Response Example (Cron Check-in)
```json
{
  "state": "reporting",
  "schedule_type": "cron",
  "reported_at": "2018-01-16T12:36:11Z",
  "expected_at": "2018-01-17T12:36:11Z",
  "missed_count": 0,
  "grace_period": "",
  "id": "YYYYYY",
  "name": "Hourly check",
  "slug": "hourly-check",
  "url": "https://api.honeybadger.io/v1/check_in/YYYYYY",
  "cron_schedule": "30 * * * *",
  "cron_timezone": "UTC"
}
```
```

--------------------------------

### Get Project List or Details with cURL

Source: https://docs.honeybadger.io/api/projects

Fetches a list of all projects accessible by the authentication token or details for a specific project ID. Requires an authentication token and optionally an account ID. The response is in JSON format.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects?account_id=ACCOUNT_ID
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID
```

--------------------------------

### Reporting Check-Ins

Source: https://docs.honeybadger.io/api/reporting-check-ins

This section describes how to report a check-in using the Honeybadger.io API, either via a GET request or by sending an email.

```APIDOC
## GET /v1/check_in/{id}

### Description
Reports a check-in using its unique ID.

### Method
GET

### Endpoint
`https://api.honeybadger.io/v1/check_in/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier for the check-in.

### Request Example
```bash
curl https://api.honeybadger.io/v1/check_in/XyZZy 
```

## GET /v1/check_in/{apiKey}/{slug}

### Description
Reports a check-in using the project's API key and a specified slug.

### Method
GET

### Endpoint
`https://api.honeybadger.io/v1/check_in/{apiKey}/{slug}`

### Parameters
#### Path Parameters
- **apiKey** (string) - Required - Your project's API key.
- **slug** (string) - Required - The identifier (slug) for the check-in.

### Request Example
```bash
curl https://api.honeybadger.io/v1/check_in/Your project API key/my_identifier 
```

## Email Reporting

### Description
Reports a check-in by sending an email to a specific address. No subject or body is required.

### Endpoint
`{id}@report.hbchk.in`

### Parameters
#### Email Address
- **{id}** (string) - Required - The unique identifier for the check-in, which forms part of the email address.

### Usage
Send an email to `{id}@report.hbchk.in` where `{id}` is the case-sensitive ID from the endpoint URL.
```

--------------------------------

### Get Honeybadger Account Invitations

Source: https://docs.honeybadger.io/api/accounts

Retrieves a list of all account invitations for a given account, or details for a specific invitation. This is useful for managing pending user access to an account.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/accounts/ID/invitations 
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/accounts/ID/invitations/ID 
```

--------------------------------

### Report Check-in via GET Request with Slug (Bash)

Source: https://docs.honeybadger.io/api/reporting-check-ins

Report a check-in using a slug identifier and the project's API key. This provides an alternative to using the check-in ID.

```bash
curl https://api.honeybadger.io/v1/check_in/Your project API key/my_identifier 
```

--------------------------------

### Get Site List or Site Details using cURL

Source: https://docs.honeybadger.io/api/uptime

Retrieves a list of all sites for a given project or details for a specific site using the Honeybadger.io API. Requires authentication with an API token and project ID. The response is in JSON format.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/sites
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/sites/ID
```

--------------------------------

### Get all status pages

Source: https://docs.honeybadger.io/api/status-pages

Retrieves a list of all status pages associated with a specific account.

```APIDOC
## GET /v2/accounts/ACCOUNT_ID/status_pages

### Description
Retrieves a list of all status pages in the specified account.

### Method
GET

### Endpoint
`/v2/accounts/{ACCOUNT_ID}/status_pages`

### Parameters
#### Path Parameters
- **ACCOUNT_ID** (string) - Required - The ID of the account to retrieve status pages from.

### Request Example
```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/accounts/ACCOUNT_ID/status_pages
```

### Response
#### Success Response (200)
- **results** (array) - A list of status page objects.
  - **id** (string) - The unique identifier for the status page.
  - **name** (string) - The name of the status page.
  - **account_id** (string) - The ID of the account the status page belongs to.
  - **domain** (string) - The custom domain for the status page, if any.
  - **url** (string) - The URL of the status page.
  - **created_at** (string) - The timestamp when the status page was created.
  - **domain_verified_at** (string) - The timestamp when the custom domain was verified, if applicable.
  - **sites** (array) - A list of sites associated with the status page.
  - **check_ins** (array) - A list of check-ins associated with the status page.

#### Response Example
```json
{
  "results": [
    {
      "id": "rMGSZB",
      "name": "My Awesome Status Page",
      "account_id": "Me3upk",
      "domain": "your.custom.domain",
      "url": "your.custom.domain",
      "created_at": "2022-01-29T11:26:19.120153Z",
      "domain_verified_at": "2022-01-29T14:02:32.570227Z",
      "sites": [],
      "check_ins": [
        {
          "check_in_id": "XXXXXX",
          "display_name": "Nightly billing",
          "state": "reporting",
          "reported_at": "2022-01-29T00:00:02.523254Z"
        }
      ]
    },
    {
      "id": "vWbSWr",
      "name": "Really Awesome Status Page",
      "account_id": "Me3upk",
      "domain": null,
      "url": "vWbSWr.status.hbuptime.com",
      "created_at": "2022-01-29T11:09:32.570227Z",
      "domain_verified_at": null,
      "sites": [
        {
          "site_id": "7d25f58b-d1a9-49f1-b10a-ac7ee44a6537",
          "display_name": "Main site",
          "state": "up",
          "last_checked_at": "2022-01-29T11:09:30.982801Z"
        },
        {
          "site_id": "7d25f58b-d1a9-49f1-b10a-ac7ee44a6557",
          "display_name": "API",
          "state": "up",
          "last_checked_at": "2022-01-29T11:04:28.675309Z"
        }
      ],
      "check_ins": []
    }
  ]
}
```
```

--------------------------------

### Fetch Notices Per Day (Bash)

Source: https://docs.honeybadger.io/api/projects

Retrieves a count of error notifications processed, grouped by day starting at midnight UTC. Requires an authentication token and project ID.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/reports/notices_per_day 
```

--------------------------------

### Notices by User Data Structure (JSON)

Source: https://docs.honeybadger.io/api/projects

Example JSON output for the 'notices_by_user' endpoint, showing an array of arrays where each inner array contains the user identifier (email) and the count of notices associated with them.

```json
[ [ "julia@example.com", 579 ], [ "marie@example.com", 289 ] ]
```

--------------------------------

### Get Honeybadger Deploy List or Details (Bash)

Source: https://docs.honeybadger.io/api/deployments

Fetches a list of deploys for a given project or details for a specific deploy using the Honeybadger API. The request is made using curl with authentication. The response is in JSON format and can be filtered using various URL parameters.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/deploys curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/deploys/ID 
```

--------------------------------

### Notices by Location Data Structure (JSON)

Source: https://docs.honeybadger.io/api/projects

Example JSON output for the 'notices_by_location' endpoint, showing an array of arrays where each inner array contains the error location and its count.

```json
[ [ "inquiries#create", 2904 ], [ "members#details", 862 ] ]
```

--------------------------------

### Get Comment List or Details - Bash

Source: https://docs.honeybadger.io/api/comments

Retrieves a list of comments for a specific fault or details of a single comment. Requires authentication with a provided `AUTH_TOKEN` and project/fault IDs. The output is a JSON object.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/faults/ID/comments
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/faults/ID/comments/ID
```

--------------------------------

### Get Honeybadger Check-ins (cURL)

Source: https://docs.honeybadger.io/api/check-ins

Retrieve a list of check-ins or details of a specific check-in for a given project using cURL. The response format differs slightly for simple and cron check-ins.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/check_ins
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/check_ins/ID
```

--------------------------------

### Notices Per Day Data Structure (JSON)

Source: https://docs.honeybadger.io/api/projects

Example JSON output for the 'notices_per_day' endpoint, showing an array of arrays where each inner array contains the date (in ISO 8601 format) and the count of notices for that day.

```json
[ [ "2023-01-24T00:00:00.000000+00:00", 3161 ], [ "2023-01-25T00:00:00.000000+00:00", 2620 ], [ "2023-01-26T00:00:00.000000+00:00", 2852 ], [ "2023-01-27T00:00:00.000000+00:00", 2502 ], [ "2023-01-28T00:00:00.000000+00:00", 1759 ], [ "2023-01-29T00:00:00.000000+00:00", 1420 ], [ "2023-01-30T00:00:00.000000+00:00", 3027 ], [ "2023-01-31T00:00:00.000000+00:00", 1624 ] ]
```

--------------------------------

### Notices by Class Data Structure (JSON)

Source: https://docs.honeybadger.io/api/projects

Example JSON output for the 'notices_by_class' endpoint, showing an array of arrays where each inner array contains the error class name and its count.

```json
[ [ "RuntimeError", 8347 ], [ "SocketError", 4651 ] ]
```

--------------------------------

### Get Single Honeybadger Environment Details (API)

Source: https://docs.honeybadger.io/api/environments

Fetches the details of a specific environment within a Honeybadger project. This API call requires the project ID and the environment ID. The output is a JSON object representing the environment's configuration.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/PROJECT_ID/environments/ID 
```

--------------------------------

### Get Single Status Page Details (Bash)

Source: https://docs.honeybadger.io/api/status-pages

Fetches the detailed information for a specific status page using its ID and the account ID. Requires an authentication token. The output is a JSON object representing the status page.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/accounts/ACCOUNT_ID/status_pages/ID 
```

--------------------------------

### Get All Status Pages (Bash)

Source: https://docs.honeybadger.io/api/status-pages

Retrieves a list of all status pages associated with a specific account. Requires an authentication token and the account ID. The response is a JSON object containing a list of status pages.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/accounts/ACCOUNT_ID/status_pages 
```

--------------------------------

### Get All Honeybadger Environments (API)

Source: https://docs.honeybadger.io/api/environments

Retrieves a list of all recorded environments for a specific Honeybadger project. This operation is performed using a cURL command with authentication and the project ID. The response is a JSON object containing an array of environment details.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/PROJECT_ID/environments 
```

--------------------------------

### Get Project Integrations List with cURL

Source: https://docs.honeybadger.io/api/projects

Fetches a list of integrations configured for a specific project. Integrations, also known as channels, can include webhooks and other notification methods. The response is a JSON array detailing each integration's settings. Authentication token and project ID are required.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/integrations
```

--------------------------------

### Sample JSON Payloads for Honeybadger Events

Source: https://docs.honeybadger.io/api/reporting-events

Examples of newline-delimited JSON payloads for reporting events to Honeybadger. These demonstrate unstructured logs, structured logs with metadata, and custom events like user signups. The 'ts' field is optional and should be RFC3339 formatted if included.

```javascript
{"ts": "2023-08-31T09:19:30Z", "message": "This is a log line"} {"ts": "2023-08-31T09:19:30Z", "message": "This is another log line"} 
```

```javascript
{"ts": "2023-08-31T16:17:57Z", "level": "info", "action": "health", "controller": "PagesController", "method": "GET", "path": "/health", "status": 200, "duration": 322} 
```

```javascript
{"ts": "2023-08-31T14:31:05Z", "event": "user.signup", "user": {"id": 42, "source": "Daring Fireball Ad"}} {"ts": "2023-08-31T14:33:05Z", "event": "company.created", "project": {"id": 54, "name": "Spacely Space Sprockets", "shared": true}} 
```

--------------------------------

### Get List of Notices for a Fault via API

Source: https://docs.honeybadger.io/api/faults

Retrieves a list of notices associated with a specific Honeybadger fault. The response is in JSON format and includes details like creation time, environment, fault ID, message, and backtrace. Filtering is supported via URL parameters such as `created_after`, `created_before`, and `limit`.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/faults/ID/notices 
```

```json
{ "created_at": "2013-02-11T19:18:31.123931Z", "environment": { "environment_name": "development", "hostname": "apollo.local", "project_root": { "path": "/Users/bob/code/crywolf" } }, "cookies" { ... }, "fault_id": 2, "id": "f78391e4-7789-49f0-888e-5f6c07a222f2", "url": "https://app.honeybadger.io/projects/1/faults/2/d23e5f62-747f-11e2-a65e-4f2716edc8b7" "message": "RuntimeError: This is a runtime error", "web_environment": { "CONTENT_LENGTH": "82", "CONTENT_TYPE": "application/x-www-form-urlencoded", "HTTP_USER_AGENT": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_4) AppleWebKit/537.4 (KHTML, like Gecko) Chrome/22.0.1229.79 Safari/537.4", ... }, "request": { "action": "runtime_error", "component": "pages", "context": { "cart_id": "8EF99AFC-B4DB-4FC5-A92A-9A6F86ABD364" }, "params": { "_method": "post", "a": "1", "action": "runtime_error", "authenticity_token": "...", "b": "2", "controller": "pages" }, "session": { "_csrf_token": "...", "session_id": "..." }, "url": "http://example.com/pages/runtime_error?a=1&b=2", "user": { "email": "foo@bar.com", "id": 1 } }, "backtrace": [ { "number": "4", "file": "/Users/westley/code/crywolf/app/controllers/pages_controller.rb", "method": "runtime_error" }, ... ], "application_trace": [] } 
```

--------------------------------

### Get Outages for a Site using cURL

Source: https://docs.honeybadger.io/api/uptime

Retrieves a list of outages for a specific uptime monitoring site. This API call requires authentication and the project and site IDs. The response includes details about when the site went down and came back up, along with status codes and headers. The list can be filtered by creation time and a limit.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/sites/ID/outages
```

--------------------------------

### Notices by day

Source: https://docs.honeybadger.io/api/projects

Returns a count of error notifications processed, grouped by day (with days starting at midnight UTC). This endpoint can be filtered by start date, stop date, and environment.

```APIDOC
## GET /v2/projects/ID/reports/notices_per_day

### Description
Returns a count of error notifications processed, grouped by day.

### Method
GET

### Endpoint
/v2/projects/{ID}/reports/notices_per_day

### Parameters
#### Query Parameters
- **start** (string) - Optional - Date/time in ISO 8601 format for the beginning of the reporting period.
- **stop** (string) - Optional - Date/time in ISO 8601 format for the end of the reporting period.
- **environment** (string) - Optional - Limit results to this environment.

### Request Example
```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/reports/notices_per_day?start=2023-01-01T00:00:00Z&stop=2023-01-31T23:59:59Z&environment=production
```

### Response
#### Success Response (200)
- **Array** - An array where each element is a two-element array: `[dateTime, count]`.

#### Response Example
```json
[ 
  [ "2023-01-24T00:00:00.000000+00:00", 3161 ], 
  [ "2023-01-25T00:00:00.000000+00:00", 2620 ] 
]
```
```

--------------------------------

### Report Check-in via GET Request (Bash)

Source: https://docs.honeybadger.io/api/reporting-check-ins

Report a check-in by sending a GET request to the provided endpoint URL. This method uses the unique check-in ID.

```bash
curl https://api.honeybadger.io/v1/check_in/XyZZy 
```

--------------------------------

### Create Check-in

Source: https://docs.honeybadger.io/api/check-ins

Creates a new check-in for a project. You can specify whether it's a simple or cron check-in.

```APIDOC
## POST /v2/projects/{ID}/check_ins

### Description
Creates a new check-in for a project. You can specify whether it's a simple or cron check-in. The response will be the same as the 'Get Check-ins' endpoint.

### Method
POST

### Endpoint
`/v2/projects/{ID}/check_ins`

### Parameters
#### Path Parameters
- **ID** (string) - Required - The unique identifier for the project.

#### Request Body
- **check_in** (object) - Required - Contains the details of the check-in to create.
  - **name** (string) - Required - The name of the check-in.
  - **slug** (string) - Optional - A human-friendly identifier for the check-in URL.
  - **schedule_type** (string) - Required - The type of check-in, either 'simple' or 'cron'.
  - **report_period** (string) - Required for simple check-ins - The time period before the check-in is reported as missing (e.g., '1 day', '5 minutes').
  - **grace_period** (string) - Optional - The grace period before a check-in is considered missed.
  - **cron_schedule** (string) - Required for cron check-ins - The cron-compatible schedule string.
  - **cron_timezone** (string) - Optional for cron check-ins - The timezone for the cron schedule (defaults to 'UTC').

### Request Example
```json
{
  "check_in": {
    "name": "Daily reports",
    "report_period": "1 day",
    "schedule_type": "simple"
  }
}
```

### Response
#### Success Response (200)
See 'Get Check-ins' endpoint for response details.
```

--------------------------------

### Data API - Environments

Source: https://docs.honeybadger.io/api/index

Retrieve information about your environments.

```APIDOC
## GET /v1/environments

### Description
Retrieve a list of your environments.

### Method
GET

### Endpoint
/v1/environments

### Response
#### Success Response (200)
- **environments** (array) - An array of environment objects.
  - **id** (string) - Environment ID.
  - **name** (string) - Environment name.

#### Response Example
```json
{
  "environments": [
    {
      "id": "env-prod",
      "name": "production"
    }
  ]
}
```
```

--------------------------------

### Get Site Outages

Source: https://docs.honeybadger.io/api/uptime

Retrieves a list of past outages for a specific site.

```APIDOC
## GET /v2/projects/{ID}/sites/{ID}/outages

### Description
Retrieves a list of recorded outages for a specific site.

### Method
GET

### Endpoint
`/v2/projects/{ID}/sites/{ID}/outages`

### Parameters
#### Path Parameters
- **ID** (string) - Required - The unique identifier for the project.
- **ID** (string) - Required - The unique identifier for the site.

#### Query Parameters
- **created_after** (integer) - Optional - Unix timestamp to filter outages created after this time.
- **created_before** (integer) - Optional - Unix timestamp to filter outages created before this time.
- **limit** (integer) - Optional - The maximum number of results to return (default and max is 25).

### Response
#### Success Response (200)
- **down_at** (string) - Timestamp when the site went down.
- **up_at** (string) - Timestamp when the site recovered.
- **created_at** (string) - Timestamp when the outage record was created.
- **status** (integer) - The HTTP status code received during the outage.
- **reason** (string) - A description of the outage reason.
- **headers** (object) - The response headers received during the outage.

#### Response Example
```json
{
  "down_at": "2015-02-17T18:20:44.776959Z",
  "up_at": "2015-02-17T18:22:35.614678Z",
  "created_at": "2015-02-17T18:20:44.777914Z",
  "status": 301,
  "reason": "Expected 2xx status code. Got 301",
  "headers": {
    "Date": "Tue, 17 Feb 2015 18:20:44 GMT",
    "Server": "DNSME HTTP Redirection",
    "Location": "http://text.vote/polls",
    "Connection": "close",
    "Content-Length": "0"
  }
}
```
```

--------------------------------

### Project List Endpoint

Source: https://docs.honeybadger.io/api/getting-started

Retrieves a list of projects associated with your Honeybadger account. Authentication is handled via HTTP Basic Auth using your personal authentication token.

```APIDOC
## GET /v2/projects

### Description
Retrieves a list of all projects within your Honeybadger account.

### Method
GET

### Endpoint
https://app.honeybadger.io/v2/projects

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects
```

### Response
#### Success Response (200)
- **links** (object) - Contains pagination links.
- **results** (array) - An array of project objects.

#### Response Example
```json
{
  "links": {
    "self": "https://app.honeybadger.io/v2/projects",
    "next": "https://app.honeybadger.io/v2/projects?page=2"
  },
  "results": [
    {
      "id": "123",
      "name": "My Awesome App"
    },
    {
      "id": "456",
      "name": "Another Service"
    }
  ]
}
```
```

--------------------------------

### Get All Accounts

Source: https://docs.honeybadger.io/api/accounts

Fetches a list of all accounts that the authenticated user belongs to.

```APIDOC
## GET /v2/accounts

### Description
Retrieves a list of all accounts associated with the authenticated user.

### Method
GET

### Endpoint
/v2/accounts

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/accounts/
```

### Response
#### Success Response (200)
- **results** (array) - An array of account objects.
  - **id** (string) - The unique identifier for the account.
  - **email** (string) - The email address associated with the account.
  - **name** (string) - The name of the account.
  - **active** (boolean) - Indicates if the account is active.
  - **parked** (boolean) - Indicates if the account is parked.
- **links** (object) - Links related to the response.
  - **self** (string) - The URL for the current request.

#### Response Example
```json
{
  "results": [
    {
      "id": "Me3upk",
      "email": "homerjsimpson@gmail.com",
      "name": "homer",
      "active": true,
      "parked": false
    },
    {
      "id": "9bYfrm",
      "email": "homer.j@simpsons.io",
      "name": "Work",
      "active": true,
      "parked": false
    }
  ],
  "links": {
    "self": "http://localhost:3000/v2/accounts"
  }
}
```
```

--------------------------------

### Data API - Projects

Source: https://docs.honeybadger.io/api/index

Retrieve information about your projects.

```APIDOC
## GET /v1/projects

### Description
Retrieve a list of your projects.

### Method
GET

### Endpoint
/v1/projects

### Response
#### Success Response (200)
- **projects** (array) - An array of project objects.
  - **id** (string) - Project ID.
  - **name** (string) - Project name.

#### Response Example
```json
{
  "projects": [
    {
      "id": "proj-1",
      "name": "My Awesome App"
    }
  ]
}
```
```

--------------------------------

### Deployments API

Source: https://docs.honeybadger.io/api/index

Report deployment information to Honeybadger for better error context.

```APIDOC
## POST /v1/deploys

### Description
Record a new deployment in Honeybadger.

### Method
POST

### Endpoint
/v1/deploys

### Parameters
#### Request Body
- **environment** (string) - Required - The deployment environment (e.g., 'production', 'staging').
- **version** (string) - Optional - The version of the deployed code.
- **local_username** (string) - Optional - The username of the person who initiated the deployment.

### Request Example
```json
{
  "environment": "production",
  "version": "v1.2.3",
  "local_username": "deployer"
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the deployment.

#### Response Example
```json
{
  "id": "deploy-xyz789"
}
```
```

--------------------------------

### Get Fault Occurrences Count

Source: https://docs.honeybadger.io/api/faults

Retrieves the count of occurrences for a specific fault over a given period.

```APIDOC
## GET /v2/projects/{ID}/faults/{ID}/occurrences

### Description
Provides the number of times errors have been encountered for a particular fault.

### Method
GET

### Endpoint
`/v2/projects/{project_id}/faults/{fault_id}/occurrences`

### Query Parameters
- **period** (string) - Optional - The period for which to count occurrences. Possible values: `hour`, `day`, `week`, `month`. Defaults to `hour`.

### Response
#### Success Response (200)
An array of timestamp-count pairs.

#### Response Example
```json
[
  [1510963200, 1],
  [1511049600, 0],
  [1511136000, 0],
  [1511222400, 1]
]
```
```

--------------------------------

### Create Honeybadger Account Invitation

Source: https://docs.honeybadger.io/api/accounts

Allows for the creation of an invitation for a new user to join a Honeybadger account. The invitation can specify the user's email, role, and the teams they should be added to. The response includes the invitation details.

```bash
curl -u AUTH_TOKEN: -X POST -H 'Content-type: application/json' \ 
-d '{"invitation":{"email":"inigo@honeybadger.io"}}' \ 
  https://app.honeybadger.io/v2/accounts/ID/invitations 
```

--------------------------------

### Get Uptime Checks

Source: https://docs.honeybadger.io/api/uptime

Retrieves a list of historical uptime check results for a specific site.

```APIDOC
## GET /v2/projects/{ID}/sites/{ID}/uptime_checks

### Description
Retrieves a list of historical uptime check results for a specific site.

### Method
GET

### Endpoint
`/v2/projects/{ID}/sites/{ID}/uptime_checks`

### Parameters
#### Path Parameters
- **ID** (string) - Required - The unique identifier for the project.
- **ID** (string) - Required - The unique identifier for the site.

#### Query Parameters
- **created_after** (integer) - Optional - Unix timestamp to filter checks created after this time.
- **created_before** (integer) - Optional - Unix timestamp to filter checks created before this time.
- **limit** (integer) - Optional - The maximum number of results to return (default and max is 25).

### Response
#### Success Response (200)
- **created_at** (string) - Timestamp when the check was performed.
- **duration** (integer) - The duration of the check in milliseconds.
- **location** (string) - The location from which the check was performed.
- **up** (boolean) - Indicates whether the site was up during this check.

#### Response Example
```json
{
  "created_at": "2016-06-16T20:19:32.852569Z",
  "duration": 1201,
  "location": "Singapore",
  "up": true
}
```
```

--------------------------------

### Get Account Information

Source: https://docs.honeybadger.io/api/accounts

Retrieves detailed information about a specific account, including quota consumption.

```APIDOC
## GET /v2/accounts/{ID}

### Description
Fetches detailed information for a specific account, including current monthly quota consumption.

### Method
GET

### Endpoint
/v2/accounts/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - The unique identifier of the account.

#### Query Parameters
None

### Request Example
```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/accounts/ID
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the account.
- **email** (string) - The email address associated with the account.
- **name** (string) - The name of the account.
- **active** (boolean) - Indicates if the account is active.
- **parked** (boolean) - Indicates if the account is parked.
- **quota_consumed** (number) - The percentage of the monthly quota consumed (e.g., 0.75 for 75%).
- **api_stats** (object) - Statistics on API usage for the current month.
  - **stored** (array) - Array of [timestamp, count] pairs for stored notifications.
  - **limited** (array) - Array of [timestamp, count] pairs for throttled notifications.
  - **ignored** (array) - Array of [timestamp, count] pairs for ignored notifications.

#### Response Example
```json
{
  "id": "Me3upk",
  "email": "homerjsimpson@gmail.com",
  "name": "homer",
  "active": true,
  "parked": false,
  "quota_consumed": 0.75,
  "api_stats": {
    "stored": [ [ 1648767600, 116 ], [ 1648771200, 65 ] ],
    "limited": [],
    "ignored": []
  }
}
```
```

--------------------------------

### Data API - Deployments

Source: https://docs.honeybadger.io/api/index

Retrieve deployment history.

```APIDOC
## GET /v1/deploys

### Description
Retrieve a list of past deployments.

### Method
GET

### Endpoint
/v1/deploys

### Parameters
#### Query Parameters
- **environment** (string) - Optional - Filter by deployment environment.

### Response
#### Success Response (200)
- **deploys** (array) - An array of deployment objects.
  - **id** (string) - Deployment ID.
  - **environment** (string) - Deployment environment.
  - **version** (string) - Deployment version.
  - **deployed_at** (string) - Timestamp of deployment.

#### Response Example
```json
{
  "deploys": [
    {
      "id": "deploy-xyz789",
      "environment": "production",
      "version": "v1.2.3",
      "deployed_at": "2023-10-27T09:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Create Honeybadger Environment (API)

Source: https://docs.honeybadger.io/api/environments

Creates a new environment for a Honeybadger project. This POST request requires the project ID and a JSON payload specifying the environment's name and optional notification settings. A successful creation returns a 201 Created status with the new environment's details.

```bash
curl -u AUTH_TOKEN: -X POST -H 'Content-type: application/json' \
 -d '{         "environment": {             "name": "Test",             "notifications": true         }     }' https://app.honeybadger.io/v2/projects/PROJECT_ID/environments 
```

--------------------------------

### Get a single status page's details

Source: https://docs.honeybadger.io/api/status-pages

Retrieves the details of a specific status page using its ID.

```APIDOC
## GET /v2/accounts/ACCOUNT_ID/status_pages/ID

### Description
Retrieves the details of a specific status page.

### Method
GET

### Endpoint
`/v2/accounts/{ACCOUNT_ID}/status_pages/{ID}`

### Parameters
#### Path Parameters
- **ACCOUNT_ID** (string) - Required - The ID of the account the status page belongs to.
- **ID** (string) - Required - The ID of the status page to retrieve.

### Request Example
```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/accounts/ACCOUNT_ID/status_pages/ID
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the status page.
- **name** (string) - The name of the status page.
- **account_id** (string) - The ID of the account the status page belongs to.
- **domain** (string) - The custom domain for the status page, if any.
- **url** (string) - The URL of the status page.
- **created_at** (string) - The timestamp when the status page was created.
- **domain_verified_at** (string) - The timestamp when the custom domain was verified, if applicable.
- **sites** (array) - A list of sites associated with the status page.
- **check_ins** (array) - A list of check-ins associated with the status page.

#### Response Example
```json
{
  "id": "vWbSWr",
  "name": "Really Awesome Status Page",
  "account_id": "Me3upk",
  "domain": null,
  "url": "vWbSWr.status.hbuptime.com",
  "created_at": "2022-01-29T11:09:32.570227Z",
  "domain_verified_at": null,
  "sites": [
    {
      "site_id": "7d25f58b-d1a9-49f1-b10a-ac7ee44a6537",
      "display_name": "Main site",
      "state": "up",
      "last_checked_at": "2022-01-29T11:09:30.982801Z"
    },
    {
      "site_id": "7d25f58b-d1a9-49f1-b10a-ac7ee44a6557",
      "display_name": "API",
      "state": "up",
      "last_checked_at": "2022-01-29T11:04:28.675309Z"
    }
  ],
  "check_ins": []
}
```
```

--------------------------------

### Create Site

Source: https://docs.honeybadger.io/api/uptime

Creates a new uptime check for a specified site within a project.

```APIDOC
## POST /v2/projects/{ID}/sites

### Description
Creates a new site uptime check for the given project.

### Method
POST

### Endpoint
`/v2/projects/{ID}/sites`

### Parameters
#### Path Parameters
- **ID** (string) - Required - The unique identifier for the project.

#### Request Body
- **site** (object) - Required - Contains the site configuration.
  - **name** (string) - Required - The name of the site.
  - **url** (string) - Required - The URL to monitor.
  - **frequency** (integer) - Optional - Number of minutes between checks (valid values: 1, 5, 15). Defaults to 5.
  - **match** (string) - Optional - Status code or text for passing checks (unused if `match_type` is 'success').
  - **match_type** (string) - Optional - Type of match ('success', 'exact', 'include', 'exclude'). Defaults to 'success'.
  - **request_method** (string) - Optional - HTTP method for the check (GET, POST, PUT, PATCH, DELETE). Defaults to GET.
  - **request_body** (string) - Optional - The body content to send with the request.
  - **request_headers** (array) - Optional - Array of header objects `[{ key: 'Header-Name', value: 'Header-Value' }]` to include in the request.
  - **locations** (array) - Optional - Array of strings specifying check locations (e.g., `['London', 'Virginia']`). Defaults to all locations.
  - **validate_ssl** (boolean) - Optional - Whether to fail the check if the SSL certificate is invalid or expired. Defaults to true.
  - **timeout** (integer) - Optional - **Business and Enterprise only.** How long to wait for a response (seconds, 30-120). Defaults to 30.
  - **outage_threshold** (integer) - Optional - Number of unsuccessful checks to trigger an alert. Defaults to alerting on half failed locations.
  - **active** (boolean) - Optional - Whether to enable the checks. Defaults to true.

### Request Example
```json
{
  "site": {
    "name": "My site",
    "url": "https://www.example.com/",
    "frequency": 15,
    "request_method": "POST",
    "request_body": "payload",
    "request_headers": [
      {
        "key": "Content-type",
        "value": "application/json"
      }
    ],
    "locations": [
      "London"
    ],
    "validate_ssl": false,
    "timeout": 60,
    "outage_threshold": 3,
    "active": true
  }
}
```

### Response
#### Success Response (200)
Returns the created site object with its assigned ID and current status.
```

--------------------------------

### Get All Honeybadger Accounts

Source: https://docs.honeybadger.io/api/accounts

Retrieves a list of all accounts associated with the authenticated user. This API call requires authentication and returns account details in JSON format.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/accounts/ 
```
Tokens:
Raw