Ethos Developers - API Docs
  • API Documentation
    • Introduction
    • API v2
      • Activity
      • Categories
      • Chains
      • Contributions
      • Nfts
      • Projects
      • Project Votes
      • Score
      • System
      • Users
      • Xp
    • API v1 (deprecated)
      • Activities
      • Addresses
      • Attestations
      • Categories
      • Contracts
      • Contributions
      • Curated Lists
      • ENS
      • Events
      • Exchange Rates
      • Fees
      • Invitations
      • Markets
      • Notifications
      • Profiles
      • Replies
      • Reviews
      • Scores
      • Search
      • Signatures
      • Slashes
      • Twitter
      • Users
      • Vouches
      • XP
  • Whitepaper
    • Whitepaper
Powered by GitBook
On this page
  1. API Documentation
  2. API v2

System

PreviousScoreNextUsers

Health check endpoint

get
Responses
200
Successful response
application/json
500
Internal server error
application/json
get
GET /api/v2/healthcheck HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "ok": true
}

Authenticated health check endpoint

get
Authorizations
Responses
200
Successful response
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
500
Internal server error
application/json
get
GET /api/v2/healthcheck/authenticated HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ok": true,
  "profileId": 1
}

Always fail health check endpoint with 418 teapot

get
Responses
200
Successful response
application/json
Responseany
500
Internal server error
application/json
get
GET /api/v2/healthcheck/always-fail HTTP/1.1
Host: api.ethos.network
Accept: */*

No content
  • GETHealth check endpoint
  • GETAuthenticated health check endpoint
  • GETAlways fail health check endpoint with 418 teapot