Skip to main content

Health

The indexes/{index_name}/health endpoint provides information about the health of a Marqo index.

Get health

GET /indexes/{index_name}/health

Gets the health of a Marqo index.

Example​

=== "Marqo Open Source" === "cURL"

curl -XGET http://localhost:8882/indexes/my-first-index/health

=== "Python"

results = mq.index("my-first-index").health()

=== "Marqo Cloud" For Marqo Cloud, you will need to access the endpoint of your index and replace your_endpoint with this. To do this, visit Find Your Endpoint. You will also need your API Key. To obtain this key visit Find Your API Key. === "cURL"

curl -XGET your_endpoint/indexes/my-first-index/health
-H 'x-api-key: XXXXXXXXXXXXXXX'

=== "Python"

results = mq.index("my-first-index").health()

Response (Healthy Instance): 200 OK​

{
  "status": "green",
  "inference": {
    "status": "green"
  },
  "backend": {
    "status": "green",
    "memoryIsAvailable": true,
    "storageIsAvailable": true
  }
}

Response (Full Storage): 200 OK​

{
  "status": "yellow",
  "inference": {
    "status": "green"
  },
  "backend": {
    "status": "yellow",
    "memoryIsAvailable": false,
    "storageIsAvailable": false
  }
}