Health

APIs for checking the health of the service

get

Responses

200

The Health Check is successful

application/json

statusstringOptionalExample: ok

503

The Health Check is not successful

application/json

get

/health

HTTPcURLJavaScriptPython

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

503

The Health Check is not successful

application/json

get

/health/live

HTTPcURLJavaScriptPython

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

503

The Health Check is not successful

application/json

get

/health/ready

HTTPcURLJavaScriptPython

GET /marketplace/health/ready HTTP/1.1
Host: na.api.immutacloud.com
Accept: */*

{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}