API Reference

API Reference

GET /check-ssl

• Description: Check SSL status for a URL.
• Parameters:
  • url (query, required): Website URL (e.g., https://example.com).
• Response:

  {
    "valid": true, 
    "expiry_date": "2026-01-15T23:59:59", 
    "days_remaining": 288, 
    "issuer": "DigiCert Global G3 TLS ECC SHA384 2020 CA1", 
    "needs_renewal": false, 
    "error": null
  }

• Status Codes:
  • 200: Success
  • 400: Invalid URL

POST /websites/{website_id}/check-ssl

• Description: Initiate an SSL check for a registered website.
• Parameters:
  • website_id (path, required): Website ID.
• Response:

  {"message": "SSL check initiated. Results will be available in logs."}

• Status Codes:
  • 200: Success

GET /websites/{website_id}/ssl-logs

• Description: Retrieve paginated SSL logs.
• Parameters:
  • website_id (path, required)
  • limit (query, default=10, max=100)
  • cursor (query, optional): Pagination cursor
  • is_valid (query, optional): Filter by validity
• Response:

  {
    "data": [
      {
        "id": 1,
        "website_id": "3",
        "timestamp": "2025-04-02T00:00:00Z",
        "valid_until": "2025-06-01T12:00:00Z",
        "issuer": "Let's Encrypt",
        "is_valid": true,
        "error": null
      }
    ],
    "next_cursor": null
  }

• Status Codes:
  • 200: Success
  • 404: No logs found