Sign in
shim

Ping and API version negotiation

Changed on

Serves two roles:

  • as the path implies, it's a healthcheck, although there is no field in the response that indicate if shim is healthy. Basically, it not is a proper healthcheck but a basic "ping" method
  • API version negotiation. Server inspects version field to figure out which API features it should use

Important: Since this endpoint is used for negotiation, it should always stay backward/future compatible, specifically the version field

get/healthcheck

Request

  • Base URL: http://localhost:10998/api
  • URL: http://localhost:10998/api/healthcheck
  • Auth: none declared

Response

service'dstack-shim' required
versionstring required

Example response

{
  "version": "0.18.34"
}

Changes