API Health Check

GET

/api/v1/status

const url = 'https://indepai.app/api/v1/status';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://indepai.app/api/v1/status

Check API health status and dependent services

Responses

200

API status

application/json

object

success

required

boolean

data

required

object

status

required

Overall API health status

string

Allowed values: healthy degraded unhealthy

version

required

API version

string

environment

required

Current environment

string

Allowed values: development staging production

uptime

required

API uptime in seconds

number

services

required

Status of dependent services

Array<object>

object

name

required

Service name

string

status

required

Service health status

string

Allowed values: healthy degraded unhealthy

latency

Response latency in milliseconds

number

message

Status message

string

lastChecked

required

Last health check timestamp

string format: date-time

meta

required

object

timestamp

required

Timestamp in ISO 8601 format

string format: date-time

requestId

Request tracking ID

string

Example

{
  "success": true,
  "data": {
    "status": "healthy",
    "version": "1.0.0",
    "environment": "development",
    "uptime": 86400,
    "services": [
      {
        "name": "database",
        "status": "healthy",
        "latency": 15,
        "message": "Connected",
        "lastChecked": "2024-01-15T10:30:00Z"
      }
    ]
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z"
  }
}