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

cURLPython

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

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

Response (Healthy Instance): 200 OK

{
    "status": "green", 
    "backend": {
        "status": "green",
        "storage_is_available": true
    }
}

Response (Full Storage): 200 OK

{
    "status": "yellow", 
    "backend":{
        "status": "yellow",
        "storage_is_available": false
    }
}