Ping Run in API Explorer

HEAD /_ping

This is a dummy endpoint you can use to test if the server is accessible.

Responses

  • 200 text/plain

    no error

    Hide headers attributes Show headers attributes
    • Api-Version string

      Max API Version the server supports

    • Builder-Version string

      Default version of docker image builder

    • Docker-Experimental boolean

      If the server is running with experimental mode enabled

    • Swarm string

      Contains information about Swarm status of the daemon, and if the daemon is acting as a manager or worker node.

      Values are inactive, pending, error, locked, active/worker, or active/manager. Default value is inactive.

    • Cache-Control string

      Default value is no-cache, no-store, must-revalidate.

    • Pragma string

      Default value is no-cache.
  • 500 text/plain

    server error

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
HEAD /_ping 
curl \
 --request HEAD 'http://api.example.com/v1.49/_ping'
Response examples (200) 
(empty)
Response examples (500) 
{
  "message": "Something went wrong."
}