Skip to main content
GET
/
health
Health Check
curl --request GET \
  --url https://api.skop.dev/health/
{
  "status": "healthy",
  "service": "skop",
  "version": "1.0.0",
  "timestamp": "2023-11-07T05:31:56Z",
  "dependency_status": "operational"
}

Documentation Index

Fetch the complete documentation index at: https://docs.skop.dev/llms.txt

Use this file to discover all available pages before exploring further.

Returns the overall health status of the API service and its dependencies. This endpoint does not require authentication.

Example Request

const response = await fetch('https://api.skop.dev/health/')
const health = await response.json()
console.log(health)

Response

{
  "status": "healthy",
  "service": "skop", 
  "version": "1.0.0",
  "timestamp": "2025-07-24T20:50:00Z",
  "dependency_status": "operational"
}

Response Fields

FieldTypeDescription
statusstringHealth status: healthy, degraded, or unhealthy
servicestringService name identifier (always “skop”)
versionstringCurrent API version (1.0.0)
timestampstringISO 8601 timestamp of the health check
dependency_statusstringStatus of external dependencies

Health Status Values

StatusDescription
healthyAll systems operational
degradedSome non-critical issues
unhealthyCritical issues detected

Response

200 - application/json

API health status

status
enum<string>

Overall health status

Available options:
healthy,
unhealthy
service
string

Service name identifier

Example:

"skop"

version
string

Current API version

Example:

"1.0.0"

timestamp
string<date-time>

ISO 8601 timestamp of the health check

dependency_status
string

Status of external dependencies

Example:

"operational"