Documentation

3. Ping API Endpoint

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

GET /api/v1/ping/
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
X-API-Time: 0.003s


{
    "instances": {
        "primary": "localhost",
        "secondaries": []
    },
    "ha": false,
    "role": "primary",
    "version": "2.2.2"
}

3.1. 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 Tower 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