Ping endpoint | StatusGator Octri Preview

3 status codes

200ping successful

dataobjectoptional

successbooleanoptional

401unauthorized

429rate limit exceeded

errorstringoptional

Error handling

A 401 is returned: unauthorized. A 429 is returned: rate limit exceeded.

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.ping.ping();

{
  "data": {
    "message": "pong",
    "organization": {
      "id": "k2x9m7nPqR",
      "name": "Acme Inc",
      "timezone": "America/New_York"
    },
    "token": {
      "created_at": "2025-01-15T10:30:00Z",
      "expires_at": "2026-01-15T10:30:00Z",
      "id": "p8Wq3rTv5Z",
      "name": "Integration token",
      "permission": "full",
      "scope": "organization",
      "source": "dashboard",
      "user": {
        "email": "user@example.com",
        "id": "k2x9m7nPqR"
      }
    }
  },
  "success": true
}

Response

Errors