For the complete documentation index, see llms.txt. This page is also available as Markdown.

Health

APIs for checking the health of the service

get
Responses
200

The Health Check is successful

application/json
statusstringOptionalExample: ok
get/health
GET /marketplace/health HTTP/1.1
Host: na.api.immutacloud.com
Accept: */*
{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}
get
Responses
200

The Health Check is successful

application/json
statusstringOptionalExample: ok
get/health/live
GET /marketplace/health/live HTTP/1.1
Host: na.api.immutacloud.com
Accept: */*
{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}
get
Responses
200

The Health Check is successful

application/json
statusstringOptionalExample: ok
get/health/ready
GET /marketplace/health/ready HTTP/1.1
Host: na.api.immutacloud.com
Accept: */*
{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}

Last updated

Was this helpful?