Pause website monitor | StatusGator Octri Preview

2 parameters

board_idstringrequired

Unique ID of the board

idstringrequired

Unique ID of the website monitor

3 status codes

200monitor paused successfully

dataobjectoptional

successbooleanoptional

401unauthorized

404monitor not found

Error handling

A 401 is returned: unauthorized. A 404 is returned: monitor not found.

import { StatusGatorAPIUnofficialOctriFullPreview } from "statusgator-octri-preview-sdk";

const client = new StatusGatorAPIUnofficialOctriFullPreview({
  baseUrl: "https://statusgator.com/api/v3",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.websiteMonitors.pause({
  boardId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

{
  "data": {
    "alert_any_location": false,
    "alert_content_found": false,
    "check_content": false,
    "check_interval": 5,
    "check_regions": [
      "us-east",
      "us-west"
    ],
    "content": "API Status: OK",
    "created_at": "2025-09-19T09:00:00Z",
    "description": "Production API monitoring",
    "follow_redirects": true,
    "http_auth_password_set": true,
    "http_auth_username": "username",
    "http_method": "GET",
    "id": "x5y2m8nQrS",
    "last_checked_at": "2025-09-19T10:30:00Z",
    "monitor_group_id": "x5y2m8nQrS",
    "name": "My Website Monitor",
    "paused_at": null,
    "request_body": "{\"test\": true}",
    "request_headers": [
      {
        "key": "Authorization",
        "value": "Bearer token"
      }
    ],
    "response_codes": "200",
    "retry_count": 0,
    "status": "up",
    "timeout": 30,
    "updated_at": "2025-09-19T10:30:00Z",
    "url": "https://example.com"
  },
  "success": true
}

Request

Response

Errors