Ping API

Ping API

#340430

Description

The /ping resource is used to check the status of the Densify API subsystem. No credentials are required for this resource to validate the API subsystem. A ping API call performs an end-to-end test from the client to the API subsystem, ensuring that the Densify database is available and is able to respond to requests. Network elements, such as load balancers, can use this resource to verify that the web server receiving the request can be kept as an active participant in the resource pool.

Resource

/CIRBA/api/ping

Supported Operations

Table: Ping API Supported Operations

Operation

HTTP Method

Input

Output

Description

Ping the Densify API subsystem

GET /CIRBA/api/ping

Query String Parameter:

Used to return the status of a connectivity test to the Densify API subsystem with no authorization.

See Response Elements for the returned output.

Example: Successful Ping API

Parameters

Query String Parameters

Table: Ping API Query String Parameters

Parameter Name

Type

Description

timeout

(optional)

integer

The maximum time, in seconds, for the Densify API Server to respond before returning a timeout error.

If the timeout parameter is not specified, then the default timeout is set to 30 seconds.

The valid range of timeout is between 15 and 180 seconds. Specifying any value outside of the valid range will produce a malformed request error.

Example: Ping API Timeout

Response

Response Elements

The following table list elements and possible status codes returned from the /ping request.

Element

Type

Description

message

string

Detailed message of the status response.

status

errorCode

HTTP Response Code

Possible response code values of the /ping request include: 

  • 200—Successful response: API subsystem is responding to requests;
  • 400—The provided timeout value was invalid (outside the range of 15 - 180 seconds).
  • 500—There is an issue connecting to the Densify API subsystem. Contact Densify support [email protected] for further details.

Note:  Other response error messages could indicate issues with the Densify web server or other connectivity issues to the web server.

Examples

Example: Successful Ping API

The following example shows you a ping request to the Densify API subsystem with a timeout threshold of 100 seconds.

Request:

GET /CIRBA/api/ping?timeout=100

Response:

{

  "message" : "ok",

  "status" : 200

}

Example: Ping API Timeout

The following example shows you a ping request with an invalid timeout value.

Request:

GET /CIRBA/api/ping?timeout=10

Response:

{

  "message" : "Timeout value valid range: 15-180",

  "status" : 400

}