Ping Run in API Explorer

GET /_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

      The default on Linux is version "2" (BuildKit), but the daemon can be configured to recommend version "1" (classic Builder). Windows does not yet support BuildKit for native Windows images, and uses "1" (classic builder) as a default.

      This value is a recommendation as advertised by the daemon, and it is up to the client to choose which builder to use.

      Default value is 2.

    • 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 headers attributes Show headers attributes
    • Cache-Control string

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

    • Pragma string

      Default value is no-cache.

    Hide response attribute Show response attribute object
    • message string Required

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