GET ping¶

Resource URL
Parameters
Request example
Response examples

Check whether the MatchEngine search server is running.

Resource URL ¶

https://matchengine.tineye.com/<company>/rest/ping/

Parameters ¶

There are only the Common parameters.

Request example ¶

curl https://matchengine.tineye.com/<company>/rest/ping/

Response examples ¶

JSON (engine is running)¶

{
    "method": "ping",
    "status": "ok",
    "error": [],
    "result": [],
    "stats": {
        "time_ping": 3.55,
        "time_total": 3.56
    }
}

JSON (engine is down)¶

{
    "method": "ping",
    "status": "fail",
    "error": [
        "Connection to server refused. The service is down."
    ],
    "result": [],
    "stats": {
        "time_ping": 0,
        "time_total": 0.2
    }
}

XML (engine is running)¶

<?xml version="1.0" encoding="utf-8"?>
<data>
    <method>ping</method>
    <status>ok</status>
    <error/>
    <result/>
    <stats>
        <time_ping>3.55</time_ping>
        <time_total>3.56</time_total>
    </stats>
</data>

XML (engine is down)¶

<?xml version="1.0" encoding="utf-8"?>
<data>
    <method>ping</method>
    <status>fail</status>
    <error>
        <item>Connection to server refused. The service is down.</item>
    </error>
    <result/>
    <stats>
        <time_ping>0</time_ping>
        <time_total>0.2</time_total>
    </stats>
</data>