Documentation

Ping API Endpoint

A simple view that reports very basic information about this Tower instance, which is acceptable to be public information.

GET /api/v2/ping/
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept
X-API-Node: localhost
X-API-Time: 0.018s


{
"instance_groups": [
    {
        "instances": [
            "localhost"
        ],
        "capacity": 425,
        "name": "tower"
    }
],
"instances": [
    {
        "node": "localhost",
        "heartbeat": "2017-09-11T04:36:59.776Z",
        "version": "3.2.0.4414",
        "capacity": 425
    }
],
"ha": false,
"version": "3.2.0.4414",
"active_node": "localhost"
}

Reviewing the Options Endpoint

The Options Endpoint table offers a view of the Options for this endpoint. When viewing the endpoint in the browsable API, clicking the “Options” button gives you the raw JSON for the following:

name Ping
description A simple view that reports very basic information about this instance, which is acceptable to be public information.
renders
0 application/json
1 text/html
parses
0 application/json
added_in_version 2.1.0