Skip to main content

Server Health

GET/api/v1/nodes/{node_id}/monitor/server-health/

Path parameters

  • node_idPathstringrequired

    Path parameter node_id.

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • intervalQuerystringoptional

    Time interval in seconds for health checks

    • must be a numeric string
    • must be a positive integer
    example3600
  • apikeyQuerystringrequired

    API key for authenticating the Server Health request

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Specifies the target location for the server health request

    • must be a non-empty string
    • should contain only alphanumeric characters, hyphens or underscores
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code indicating the server health

example200
  • must be an integer
  • should be a valid HTTP status code (100-599)
dataobject
errorsobject
messagestring

Status message indicating the result of the health check

exampleSuccess
  • must be a non-empty string
  • maximum length of 100 characters