StatusGator API V3

https://statusgator.com/api/v3/docs
Admin
StatusGator API V3 is a REST API that provides programmatic access to StatusGator dashboards,...
Tokens:9,577
Snippets:31
Trust Score:9.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get Board History (Shell Curl)

Source: https://statusgator.com/api/v3/docs/index

Retrieves a list of historical events for monitors on a specific board within a given date range. This example uses curl to make the request, including the board ID and authentication token. Optional query parameters for start date, end date, and monitor ID can be used to filter results.

```curl
curl https://statusgator.com/api/v3/boards/m2z5x3nOJa/history \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

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

### List All Boards (Shell Curl)

Source: https://statusgator.com/api/v3/docs/index

Retrieves a paginated list of all boards belonging to your organization. This example demonstrates how to fetch boards using curl, including the necessary authentication header. Pagination can be controlled using 'page' and 'per_page' query parameters.

```curl
curl https://statusgator.com/api/v3/boards \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

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

### Get board details

Source: https://statusgator.com/api/v3/docs/index

Get details for a specific board by its ID.

```APIDOC
## GET /api/v3/boards/{id}

### Description
Get details for a specific board.

### Method
GET

### Endpoint
/api/v3/boards/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Board public ID

### Request Example
```bash
curl https://statusgator.com/api/v3/boards/m2z5x3nOJa \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Board details.
  - **id** (string) - The unique identifier for the board.
  - **name** (string) - The name of the board.
  - **public_token** (string) - A public token associated with the board.
  - **created_at** (string) - The timestamp when the board was created.
  - **updated_at** (string) - The timestamp when the board was last updated.

#### Response Example
```json
{
  "success": true,
  "data": {
    "id": "m2z5x3nOJa",
    "name": "Cloud Services",
    "public_token": "abc123def456",
    "created_at": "2025-09-12T12:35:54Z",
    "updated_at": "2025-09-12T12:40:54Z"
  }
}
```
```

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

### Get Board Details (Shell Curl)

Source: https://statusgator.com/api/v3/docs/index

Fetches detailed information for a specific board using its unique ID. The example shows a curl request to the API endpoint, requiring the board ID and authentication token. This operation returns details such as the board's name, public token, and creation/update timestamps.

```curl
curl https://statusgator.com/api/v3/boards/m2z5x3nOJa \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

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

### Get Board Monitors

Source: https://statusgator.com/api/v3/docs/index

Retrieve all monitors for a specific board. This endpoint supports filtering monitors by their status.

```APIDOC
## GET /boards/{board_id}/monitors

### Description
Retrieve all monitors for a specific board. This endpoint supports filtering monitors by their status.

### Method
GET

### Endpoint
/boards/{board_id}/monitors

### Parameters
#### Path Parameters
- **board_id** (string) - Required - Board public ID

#### Query Parameters
- **status** (string) - Optional - Filter monitors by status. Use "affected" to get all non-up monitors, or specify status values (comma-separated for multiple: "down,warn")

### Request Example
```shell
curl https://statusgator.com/api/v3/boards/m2z5x3nOJa/monitors \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (array) - An array of monitor objects, each containing detailed information about the monitor, including its ID, status, service details, and group information.

#### Response Example
```json
{
  "success": true,
  "data": [
    {
      "id": "uVLl2YK1rn",
      "checked_at": "2025-09-05T23:05:23.463Z",
      "created_at": "2023-07-06T14:18:35.607Z",
      "updated_at": "2023-07-06T14:18:35.607Z",
      "filtered_status": "warn",
      "description": null,
      "unfiltered_status": "warn",
      "last_message": "CGK (Jakarta) on 2025-09-05",
      "last_details": "In progress - Scheduled maintenance is currently in progress. We will provide updates as necessary. Sep 05, 2025 - 22:00 UTC",
      "overridden_message": null,
      "overridden_status": null,
      "overrides_locked_at": null,
      "paused_at": null,
      "filter_count": 0,
      "icon_url": "https://favicons-dev.statusgator.com/FiM8Ile0FV3wLjxF.jpg",
      "position": 3,
      "monitor_type": "ServiceMonitor",
      "early_warning_signal": false,
      "display_name": "Cloudflare",
      "service": {
        "id": "PQNMcnNFWw",
        "name": "Cloudflare",
        "slug": "cloudflare",
        "home_page_url": "http://www.cloudflare.com",
        "status_page_url": "https://www.cloudflarestatus.com",
        "icon_url": "https://favicons-dev.statusgator.com/FiM8Ile0FV3wLjxF.jpg",
        "landing_page_url": "https://studio.colinabartlett.com:3004/services/cloudflare",
        "official": true
      },
      "group": {
        "id": "k2x9m7nPqR",
        "name": "Infrastructure",
        "position": 1
      }
    }
  ]
}
```

#### Error Responses
- **400**: invalid status value
- **401**: unauthorized
- **404**: board not found
```

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

### Get board history

Source: https://statusgator.com/api/v3/docs/index

Returns a list of historical events affecting monitors on a board over a date range. Results are filtered by board ID and optionally by monitor ID, start date, and end date.

```APIDOC
## GET /api/v3/boards/{board_id}/history

### Description
Returns a list of historical events affecting monitors on a board over a date range.

### Method
GET

### Endpoint
/api/v3/boards/{board_id}/history

### Parameters
#### Path Parameters
- **board_id** (string) - Required - Board public ID

#### Query Parameters
- **start_date** (string) - Optional - Start date (inclusive) in YYYY-MM-DD. Defaults to 30 days ago if not provided.
- **end_date** (string) - Optional - End date (exclusive) in YYYY-MM-DD. Defaults to today if not provided.
- **monitor_id** (string) - Optional - Optional filter to a specific monitor ID

### Request Example
```bash
curl https://statusgator.com/api/v3/boards/m2z5x3nOJa/history \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (array) - A list of historical events.
  - **monitor_id** (string) - The ID of the monitor.
  - **name** (string) - The name of the monitor.
  - **icon_url** (string) - The URL of the monitor's icon.
  - **status** (string) - The status of the monitor (e.g., "down").
  - **started_at** (string) - The timestamp when the event started.
  - **ended_at** (string) - The timestamp when the event ended.
  - **duration** (integer) - The duration of the event in minutes.
  - **message** (string) - A message describing the event.
  - **details** (string) - Additional details about the event.
  - **early_warning_signal** (boolean) - Indicates if an early warning signal was triggered.

#### Response Example
```json
{
  "success": true,
  "data": [
    {
      "monitor_id": "L1hZpHOn63",
      "name": "Zoom",
      "icon_url": "zoom.png",
      "status": "down",
      "started_at": "2025-09-12T12:00:00Z",
      "ended_at": "2025-09-12T13:00:00Z",
      "duration": 60,
      "message": "Outage in progress",
      "details": "We are investigating",
      "early_warning_signal": false
    }
  ]
}
```
```

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

### Get Board Monitors

Source: https://statusgator.com/api/v3/docs/index

Retrieves all monitors associated with a specific board, including their group information and current status. Supports filtering by status.

```Shell
curl https://statusgator.com/api/v3/boards/m2z5x3nOJa/monitors \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

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

### Get Board History

Source: https://statusgator.com/api/v3/docs/index

Retrieves the history of a specific board, including events and status changes over a specified period.

```APIDOC
## GET /boards/{board_id}/history

### Description
Retrieves the historical data for a specific board.

### Method
GET

### Endpoint
/boards/{board_id}/history

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.

#### Query Parameters
- **start_date** (string) - Optional - The start date for the history data (YYYY-MM-DD).
- **end_date** (string) - Optional - The end date for the history data (YYYY-MM-DD).
- **monitor_id** (string) - Optional - Filter history by a specific monitor ID.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **history** (array) - A list of historical events for the board.

#### Response Example
```json
{
  "history": [
    {
      "timestamp": "2023-10-27T09:00:00Z",
      "event": "Monitor down",
      "monitor_id": "wm_123",
      "details": "Website example.com is unreachable."
    },
    {
      "timestamp": "2023-10-27T09:05:00Z",
      "event": "Monitor up",
      "monitor_id": "wm_123",
      "details": "Website example.com is back online."
    }
  ]
}
```
```

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

### List Monitor Components

Source: https://statusgator.com/api/v3/docs/index

Retrieves active components for a specific monitor, including their current status. Supports filtering by status and pagination. Returns an empty array for non-StatusPageService monitors.

```Shell
curl https://statusgator.com/api/v3/boards/k2x9m7nPqR/monitors/k2x9m7nPqR/components \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

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

### List Monitor Components

Source: https://statusgator.com/api/v3/docs/index

Retrieve active components for a specific monitor with status information. This endpoint supports filtering by status and pagination.

```APIDOC
## GET /boards/{board_id}/monitors/{monitor_id}/components

### Description
Retrieve active components for a specific monitor with status information. This endpoint supports filtering by status and pagination.

### Method
GET

### Endpoint
/boards/{board_id}/monitors/{monitor_id}/components

### Parameters
#### Path Parameters
- **board_id** (string) - Required - Public ID of the board
- **monitor_id** (string) - Required - Public ID of the monitor

#### Query Parameters
- **page** (integer) - Optional - Page number for pagination (default: 1)
- **per_page** (integer) - Optional - Number of items per page (default: 25, max: 100)
- **status** (string) - Optional - Filter components by status. Use "affected" to get all non-up components, or specify status values (comma-separated for multiple: "down,warn")

### Request Example
```shell
curl https://statusgator.com/api/v3/boards/k2x9m7nPqR/monitors/k2x9m7nPqR/components \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (array) - An array of component objects, each containing:
  - **id** (string) - The unique identifier for the component.
  - **name** (string) - The name of the component.
  - **group_name** (string) - The name of the group the component belongs to.
  - **service_id** (string) - The ID of the associated service.
  - **status** (string) - The current status of the component (e.g., "up", "down", "warn").
  - **created_at** (string) - The timestamp when the component was created.
  - **updated_at** (string) - The timestamp when the component was last updated.
- **pagination** (object) - Pagination details for the response.
  - **current_page** (integer) - The current page number.
  - **per_page** (integer) - The number of items per page.
  - **total_pages** (integer) - The total number of pages.
  - **total_count** (integer) - The total number of items.
  - **next_page** (integer|null) - The next page number, or null if it's the last page.
  - **prev_page** (integer|null) - The previous page number, or null if it's the first page.

#### Response Example
```json
{
  "success": true,
  "data": [
    {
      "id": "k2x9m7nPqR",
      "name": "API",
      "group_name": "Core Services",
      "service_id": "k2x9m7nPqR",
      "status": "up",
      "created_at": "2025-09-12T12:35:54Z",
      "updated_at": "2025-09-12T12:40:54Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "next_page": null,
    "prev_page": null
  }
}
```

#### Error Responses
- **400**: invalid status value
- **401**: unauthorized
- **404**: monitor not found
```

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

### List boards

Source: https://statusgator.com/api/v3/docs/index

Retrieve all boards belonging to your organization. Boards are used to organize and monitor specific groups of services. Results are paginated.

```APIDOC
## GET /api/v3/boards

### Description
Retrieve all boards belonging to your organization. Boards are like projects that display the status of selected services you depend on. Each board allows you to organize and monitor specific groups of services relevant to your operations. Results are paginated for efficient data retrieval.

### Method
GET

### Endpoint
/api/v3/boards

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination (default: 1)
- **per_page** (integer) - Optional - Number of items per page (default: 25, max: 100)

### Request Example
```bash
curl https://statusgator.com/api/v3/boards \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (array) - A list of boards.
  - **id** (string) - The unique identifier for the board.
  - **name** (string) - The name of the board.
  - **public_token** (string) - A public token associated with the board.
  - **created_at** (string) - The timestamp when the board was created.
  - **updated_at** (string) - The timestamp when the board was last updated.
- **pagination** (object) - Pagination details.
  - **current_page** (integer) - The current page number.
  - **per_page** (integer) - The number of items per page.
  - **total_pages** (integer) - The total number of pages.
  - **total_count** (integer) - The total number of items.
  - **next_page** (integer or null) - The next page number, or null if on the last page.
  - **prev_page** (integer or null) - The previous page number, or null if on the first page.

#### Response Example
```json
{
  "success": true,
  "data": [
    {
      "id": "m2z5x3nOJa",
      "name": "Cloud Services",
      "public_token": "abc123def456",
      "created_at": "2025-09-12T12:35:54Z",
      "updated_at": "2025-09-12T12:40:54Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "next_page": null,
    "prev_page": null
  }
}
```
```

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

### Website Monitors Operations

Source: https://statusgator.com/api/v3/docs/index

Endpoints for managing website monitors.

```APIDOC
## POST /boards/{board_id}/website_monitors

### Description
Creates a new website monitor.

### Method
POST

### Endpoint
/boards/{board_id}/website_monitors

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.

#### Request Body
- **name** (string) - Required - The name of the website monitor.
- **url** (string) - Required - The URL of the website to monitor.
- **check_interval** (integer) - Optional - The interval in seconds between checks (default: 60).

### Request Example
```json
{
  "name": "Example Website",
  "url": "https://example.com",
  "check_interval": 30
}
```

### Response
#### Success Response (201)
- **id** (string) - The ID of the created website monitor.
- **name** (string) - The name of the website monitor.
- **url** (string) - The URL of the website.
- **check_interval** (integer) - The check interval.
- **created_at** (string) - The timestamp when the website monitor was created.

#### Response Example
```json
{
  "id": "wm_123",
  "name": "Example Website",
  "url": "https://example.com",
  "check_interval": 30,
  "created_at": "2023-10-27T10:40:00Z"
}
```
```

```APIDOC
## PATCH /boards/{board_id}/website_monitors/{id}

### Description
Updates an existing website monitor.

### Method
PATCH

### Endpoint
/boards/{board_id}/website_monitors/{id}

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.
- **id** (string) - Required - The ID of the website monitor.

#### Request Body
- **name** (string) - Optional - The new name of the website monitor.
- **url** (string) - Optional - The new URL of the website.
- **check_interval** (integer) - Optional - The new interval in seconds between checks.

### Request Example
```json
{
  "check_interval": 60
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the updated website monitor.
- **name** (string) - The name of the website monitor.
- **url** (string) - The URL of the website.
- **check_interval** (integer) - The check interval.
- **updated_at** (string) - The timestamp when the website monitor was last updated.

#### Response Example
```json
{
  "id": "wm_123",
  "name": "Example Website",
  "url": "https://example.com",
  "check_interval": 60,
  "updated_at": "2023-10-27T10:45:00Z"
}
```
```

```APIDOC
## POST /boards/{board_id}/website_monitors/{id}/pause

### Description
Pauses a website monitor.

### Method
POST

### Endpoint
/boards/{board_id}/website_monitors/{id}/pause

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.
- **id** (string) - Required - The ID of the website monitor.

### Request Example
(No request body for POST requests)

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Website monitor paused successfully."
}
```
```

```APIDOC
## POST /boards/{board_id}/website_monitors/{id}/unpause

### Description
Unpauses a website monitor.

### Method
POST

### Endpoint
/boards/{board_id}/website_monitors/{id}/unpause

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.
- **id** (string) - Required - The ID of the website monitor.

### Request Example
(No request body for POST requests)

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Website monitor unpaused successfully."
}
```
```

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

### Users Operations

Source: https://statusgator.com/api/v3/docs/index

Endpoints for retrieving user information.

```APIDOC
## GET /users

### Description
Retrieves a list of users associated with the account.

### Method
GET

### Endpoint
/users

### Parameters
(No parameters)

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **users** (array) - A list of user objects.

#### Response Example
```json
{
  "users": [
    {
      "id": "string",
      "email": "string",
      "name": "string",
      "role": "string"
    }
  ]
}
```
```

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

### Service Monitors Operations

Source: https://statusgator.com/api/v3/docs/index

Endpoints for managing service monitors.

```APIDOC
## POST /boards/{board_id}/service_monitors

### Description
Creates a new service monitor.

### Method
POST

### Endpoint
/boards/{board_id}/service_monitors

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.

#### Request Body
- **name** (string) - Required - The name of the service monitor.
- **url** (string) - Required - The URL of the service to monitor.
- **expected_status_code** (integer) - Optional - The expected HTTP status code (default: 200).
- **check_interval** (integer) - Optional - The interval in seconds between checks (default: 60).

### Request Example
```json
{
  "name": "Example Service",
  "url": "https://example.com",
  "expected_status_code": 200,
  "check_interval": 30
}
```

### Response
#### Success Response (201)
- **id** (string) - The ID of the created service monitor.
- **name** (string) - The name of the service monitor.
- **url** (string) - The URL of the service.
- **expected_status_code** (integer) - The expected status code.
- **check_interval** (integer) - The check interval.
- **created_at** (string) - The timestamp when the service monitor was created.

#### Response Example
```json
{
  "id": "sm_101",
  "name": "Example Service",
  "url": "https://example.com",
  "expected_status_code": 200,
  "check_interval": 30,
  "created_at": "2023-10-27T10:25:00Z"
}
```
```

```APIDOC
## PATCH /boards/{board_id}/service_monitors/{id}

### Description
Updates an existing service monitor.

### Method
PATCH

### Endpoint
/boards/{board_id}/service_monitors/{id}

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.
- **id** (string) - Required - The ID of the service monitor.

#### Request Body
- **name** (string) - Optional - The new name of the service monitor.
- **url** (string) - Optional - The new URL of the service.
- **expected_status_code** (integer) - Optional - The new expected HTTP status code.
- **check_interval** (integer) - Optional - The new interval in seconds between checks.

### Request Example
```json
{
  "check_interval": 60
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the updated service monitor.
- **name** (string) - The name of the service monitor.
- **url** (string) - The URL of the service.
- **expected_status_code** (integer) - The expected status code.
- **check_interval** (integer) - The check interval.
- **updated_at** (string) - The timestamp when the service monitor was last updated.

#### Response Example
```json
{
  "id": "sm_101",
  "name": "Example Service",
  "url": "https://example.com",
  "expected_status_code": 200,
  "check_interval": 60,
  "updated_at": "2023-10-27T10:30:00Z"
}
```
```

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

### Ping Monitors Operations

Source: https://statusgator.com/api/v3/docs/index

Endpoints for managing ping monitors.

```APIDOC
## POST /boards/{board_id}/ping_monitors

### Description
Creates a new ping monitor.

### Method
POST

### Endpoint
/boards/{board_id}/ping_monitors

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.

#### Request Body
- **name** (string) - Required - The name of the ping monitor.
- **address** (string) - Required - The IP address or hostname to ping.
- **interval** (integer) - Optional - The interval in seconds between checks (default: 60).
- **timeout** (integer) - Optional - The timeout in seconds for the ping (default: 5).

### Request Example
```json
{
  "name": "Google DNS",
  "address": "8.8.8.8",
  "interval": 30,
  "timeout": 3
}
```

### Response
#### Success Response (201)
- **id** (string) - The ID of the created ping monitor.
- **name** (string) - The name of the ping monitor.
- **address** (string) - The IP address or hostname.
- **interval** (integer) - The check interval.
- **timeout** (integer) - The ping timeout.
- **created_at** (string) - The timestamp when the ping monitor was created.

#### Response Example
```json
{
  "id": "pm_789",
  "name": "Google DNS",
  "address": "8.8.8.8",
  "interval": 30,
  "timeout": 3,
  "created_at": "2023-10-27T10:15:00Z"
}
```
```

```APIDOC
## PATCH /boards/{board_id}/ping_monitors/{id}

### Description
Updates an existing ping monitor.

### Method
PATCH

### Endpoint
/boards/{board_id}/ping_monitors/{id}

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.
- **id** (string) - Required - The ID of the ping monitor.

#### Request Body
- **name** (string) - Optional - The new name of the ping monitor.
- **address** (string) - Optional - The new IP address or hostname.
- **interval** (integer) - Optional - The new interval in seconds.
- **timeout** (integer) - Optional - The new timeout in seconds.

### Request Example
```json
{
  "interval": 60
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the updated ping monitor.
- **name** (string) - The name of the ping monitor.
- **address** (string) - The IP address or hostname.
- **interval** (integer) - The check interval.
- **timeout** (integer) - The ping timeout.
- **updated_at** (string) - The timestamp when the ping monitor was last updated.

#### Response Example
```json
{
  "id": "pm_789",
  "name": "Google DNS",
  "address": "8.8.8.8",
  "interval": 60,
  "timeout": 5,
  "updated_at": "2023-10-27T10:20:00Z"
}
```
```

```APIDOC
## POST /boards/{board_id}/ping_monitors/{id}/pause

### Description
Pauses a ping monitor.

### Method
POST

### Endpoint
/boards/{board_id}/ping_monitors/{id}/pause

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.
- **id** (string) - Required - The ID of the ping monitor.

### Request Example
(No request body for POST requests)

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Ping monitor paused successfully."
}
```
```

```APIDOC
## POST /boards/{board_id}/ping_monitors/{id}/unpause

### Description
Unpauses a ping monitor.

### Method
POST

### Endpoint
/boards/{board_id}/ping_monitors/{id}/unpause

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.
- **id** (string) - Required - The ID of the ping monitor.

### Request Example
(No request body for POST requests)

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Ping monitor unpaused successfully."
}
```
```

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

### Monitor Groups Operations

Source: https://statusgator.com/api/v3/docs/index

Endpoints for managing monitor groups within a board.

```APIDOC
## GET /boards/{board_id}/monitor_groups

### Description
Retrieves a list of monitor groups for a specific board.

### Method
GET

### Endpoint
/boards/{board_id}/monitor_groups

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **monitor_groups** (array) - A list of monitor group objects.

#### Response Example
```json
{
  "monitor_groups": [
    {
      "id": "string",
      "name": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}
```
```

```APIDOC
## POST /boards/{board_id}/monitor_groups

### Description
Creates a new monitor group for a specific board.

### Method
POST

### Endpoint
/boards/{board_id}/monitor_groups

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.

#### Request Body
- **name** (string) - Required - The name of the monitor group.

### Request Example
```json
{
  "name": "Frontend Services"
}
```

### Response
#### Success Response (201)
- **id** (string) - The ID of the created monitor group.
- **name** (string) - The name of the monitor group.
- **created_at** (string) - The timestamp when the monitor group was created.
- **updated_at** (string) - The timestamp when the monitor group was last updated.

#### Response Example
```json
{
  "id": "mg_456",
  "name": "Frontend Services",
  "created_at": "2023-10-27T10:05:00Z",
  "updated_at": "2023-10-27T10:05:00Z"
}
```
```

```APIDOC
## GET /boards/{board_id}/monitor_groups/{id}

### Description
Retrieves a specific monitor group by its ID.

### Method
GET

### Endpoint
/boards/{board_id}/monitor_groups/{id}

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.
- **id** (string) - Required - The ID of the monitor group.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **id** (string) - The ID of the monitor group.
- **name** (string) - The name of the monitor group.
- **created_at** (string) - The timestamp when the monitor group was created.
- **updated_at** (string) - The timestamp when the monitor group was last updated.

#### Response Example
```json
{
  "id": "mg_456",
  "name": "Frontend Services",
  "created_at": "2023-10-27T10:05:00Z",
  "updated_at": "2023-10-27T10:05:00Z"
}
```
```

```APIDOC
## PATCH /boards/{board_id}/monitor_groups/{id}

### Description
Updates an existing monitor group.

### Method
PATCH

### Endpoint
/boards/{board_id}/monitor_groups/{id}

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.
- **id** (string) - Required - The ID of the monitor group.

#### Request Body
- **name** (string) - Optional - The new name for the monitor group.

### Request Example
```json
{
  "name": "Updated Frontend Services"
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the updated monitor group.
- **name** (string) - The updated name of the monitor group.
- **created_at** (string) - The timestamp when the monitor group was created.
- **updated_at** (string) - The timestamp when the monitor group was last updated.

#### Response Example
```json
{
  "id": "mg_456",
  "name": "Updated Frontend Services",
  "created_at": "2023-10-27T10:05:00Z",
  "updated_at": "2023-10-27T10:10:00Z"
}
```
```

```APIDOC
## DELETE /boards/{board_id}/monitor_groups/{id}

### Description
Deletes a specific monitor group.

### Method
DELETE

### Endpoint
/boards/{board_id}/monitor_groups/{id}

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.
- **id** (string) - Required - The ID of the monitor group.

### Request Example
(No request body for DELETE requests)

### Response
#### Success Response (204)
(No content)

#### Response Example
(No content)
```

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

### Monitoring Regions Operations

Source: https://statusgator.com/api/v3/docs/index

Endpoints for retrieving information about monitoring regions.

```APIDOC
## GET /monitoring_regions

### Description
Retrieves a list of available monitoring regions.

### Method
GET

### Endpoint
/monitoring_regions

### Parameters
(No parameters)

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **monitoring_regions** (array) - A list of monitoring region objects.

#### Response Example
```json
{
  "monitoring_regions": [
    {
      "id": "string",
      "name": "string",
      "location": "string"
    }
  ]
}
```
```

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

### Status Page Subscribers Operations

Source: https://statusgator.com/api/v3/docs/index

Endpoints for managing status page subscribers.

```APIDOC
## GET /boards/{board_id}/status_page_subscribers

### Description
Retrieves a list of subscribers for a status page.

### Method
GET

### Endpoint
/boards/{board_id}/status_page_subscribers

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **subscribers** (array) - A list of subscriber objects.

#### Response Example
```json
{
  "subscribers": [
    {
      "id": "string",
      "email": "string",
      "created_at": "string"
    }
  ]
}
```
```

```APIDOC
## POST /boards/{board_id}/status_page_subscribers

### Description
Adds a new subscriber to a status page.

### Method
POST

### Endpoint
/boards/{board_id}/status_page_subscribers

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.

#### Request Body
- **email** (string) - Required - The email address of the subscriber.

### Request Example
```json
{
  "email": "subscriber@example.com"
}
```

### Response
#### Success Response (201)
- **id** (string) - The ID of the created subscriber.
- **email** (string) - The email address of the subscriber.
- **created_at** (string) - The timestamp when the subscriber was added.

#### Response Example
```json
{
  "id": "sub_112",
  "email": "subscriber@example.com",
  "created_at": "2023-10-27T10:35:00Z"
}
```
```

```APIDOC
## DELETE /boards/{board_id}/status_page_subscribers

### Description
Removes a subscriber from a status page.

### Method
DELETE

### Endpoint
/boards/{board_id}/status_page_subscribers

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.

#### Query Parameters
- **email** (string) - Required - The email address of the subscriber to remove.

### Request Example
(No request body for DELETE requests)

### Response
#### Success Response (204)
(No content)

#### Response Example
(No content)
```

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

### Incidents Operations

Source: https://statusgator.com/api/v3/docs/index

Endpoints for managing incidents within a board.

```APIDOC
## GET /boards/{board_id}/incidents

### Description
Retrieves a list of incidents for a specific board.

### Method
GET

### Endpoint
/boards/{board_id}/incidents

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **incidents** (array) - A list of incident objects.

#### Response Example
```json
{
  "incidents": [
    {
      "id": "string",
      "name": "string",
      "status": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}
```
```

```APIDOC
## POST /boards/{board_id}/incidents

### Description
Creates a new incident for a specific board.

### Method
POST

### Endpoint
/boards/{board_id}/incidents

### Parameters
#### Path Parameters
- **board_id** (string) - Required - The ID of the board.

#### Request Body
- **name** (string) - Required - The name of the incident.
- **status** (string) - Required - The status of the incident (e.g., 'investigating', 'identified', 'resolved').

### Request Example
```json
{
  "name": "Service Outage",
  "status": "investigating"
}
```

### Response
#### Success Response (201)
- **id** (string) - The ID of the created incident.
- **name** (string) - The name of the incident.
- **status** (string) - The status of the incident.
- **created_at** (string) - The timestamp when the incident was created.
- **updated_at** (string) - The timestamp when the incident was last updated.

#### Response Example
```json
{
  "id": "inc_123",
  "name": "Service Outage",
  "status": "investigating",
  "created_at": "2023-10-27T10:00:00Z",
  "updated_at": "2023-10-27T10:00:00Z"
}
```
```

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

### Authenticate API Requests with Bearer Token

Source: https://statusgator.com/api/v3/docs/index

All API requests to StatusGator V3 require authentication using a Bearer token. This token must be included in the 'Authorization' header of your requests. Ensure you include the 'Bearer ' prefix before your API token.

```http
Authorization: Bearer YOUR_API_TOKEN
```

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

### Ping Operations

Source: https://statusgator.com/api/v3/docs/index

Endpoint for performing a ping check.

```APIDOC
## GET /ping

### Description
Performs a basic ping check to verify API availability.

### Method
GET

### Endpoint
/ping

### Parameters
(No parameters)

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the API is responsive.

#### Response Example
```json
{
  "message": "pong"
}
```
```
Tokens:
Raw