Start free

Health API

A health check that needs no key.

OperationMethod and path
Get healthGET /api/v1
GET /api/v1

Get health

app.getHealth · no API key needed

Example

curl -X GET "https://api.siaran.my/api/v1/"

Response 200

4 top-level fields
  • status string required
  • createdAt string required
  • note string required
  • platforms object required
    15 fields
    • FACEBOOK object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required
    • INSTAGRAM object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required
    • TIKTOK object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required
    • YOUTUBE object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required
    • TWITTER object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required
    • PINTEREST object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required
    • REDDIT object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required
    • MASTODON object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required
    • DISCORD object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required
    • SLACK object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required
    • BLUESKY object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required
    • GOOGLE_BUSINESS object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required
    • LINKEDIN object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required
    • THREADS object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required
    • SNAPCHAT object required
      2 fields
      • status string required
        One of: operational degraded outage maintenance
      • note string required

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error