Documentation Center

ping

Tests that a Content Delivery application is running.

Description

The ping function allows you to query if a Content Delivery application is up and running.

Parameters

action
ping
proxy
If provided, the URL of a machine that the server will ping, as a proxy.

Example URL

http://<host>:<port>/<context>/web/util.xql?action=ping&proxy=<value>

Successful Result

If the server is operational, the ping command returns a a standard API result element (<result statusCode="0" status="SUCCESS" message="A translated message" messageKey="msg.translated" />). If a proxy parameter is not provided, the session used to execute the ping is immediately closed.

Failed Result

If the proxy parameter is provided: Accessing this API feature requires the "Manage application" permission, and the function will throw a permission exception if the permission is not available. Otherwise, ping should always return successfully if the application is operational.