API Documentation

Integrate NominalCheck monitoring data into your systems with our RESTful API.

Note: This is demonstration documentation. The API endpoints and authentication methods described are conceptual and for presentation purposes only. No actual API service is provided.

Authentication

JWT Bearer Token

All API requests require authentication using JWT (JSON Web Token) bearer tokens. Include your token in the Authorization header of each request.

Authorization: Bearer YOUR_JWT_TOKEN

Token Structure

JWT tokens consist of three parts: Header, Payload, and Signature.

Header:

{
  "alg": "RS256",
  "typ": "JWT",
  "kid": "nominalcheck-2024-key-1"
}

Payload:

{
  "iss": "nominalcheck.norvo.tech",
  "sub": "demo-client-id",
  "aud": "api.nominalcheck.norvo.tech",
  "exp": 1768914861,
  "iat": 1768911261,
  "scope": "read:status read:incidents"
}

Contact sales to receive your API credentials and JWT tokens.

API Endpoints

GET/api/v1/status

Retrieve current status of all monitored systems.

Example Response:

{
  "status": "success",
  "data": {
    "overall_status": "operational",
    "systems": [
      {
        "id": "api",
        "name": "API Services",
        "status": "operational",
        "uptime": 99.98,
        "response_time_ms": 142
      }
    ],
    "last_updated": "2024-01-20T12:00:00Z"
  }
}

GET/api/v1/incidents

List all incidents with optional filtering.

Query Parameters:

• status - Filter by status (resolved, investigating, etc.)
• severity - Filter by severity (critical, major, minor)
• limit - Number of results (default: 50, max: 100)

Example Response:

{
  "status": "success",
  "data": {
    "incidents": [
      {
        "id": "inc-001",
        "title": "API Response Time Degradation",
        "severity": "minor",
        "status": "resolved",
        "start_time": "2024-01-13T10:00:00Z",
        "end_time": "2024-01-13T11:00:00Z"
      }
    ],
    "total": 1,
    "page": 1
  }
}

GET/api/v1/regions

Get information about monitoring regions and their status.

Example Response:

{
  "status": "success",
  "data": {
    "regions": [
      {
        "id": "us-east",
        "name": "US East",
        "location": "Virginia, USA",
        "status": "active",
        "coordinates": {
          "latitude": 37.4316,
          "longitude": -78.6569
        }
      }
    ]
  }
}

Rate Limits

API rate limits vary by subscription tier. Rate limit information is included in response headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Standard

1,000

requests per hour

Professional

5,000

requests per hour

Enterprise

Custom

tailored to your needs

Error Codes

Code	Description
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing JWT token
403	Forbidden - Insufficient permissions
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error - Contact support

Ready to integrate?

Contact our sales team to receive API credentials and start monitoring.

Contact Sales