Skip to main content

Monitoring Status

GET/api/v1/nodes/{node_id}/monitoring/monitoring_status/

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}}
  • apikeyQuerystringrequired

    API key used to authenticate the request

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

    Location identifier used to filter monitoring status

    • must be a non-empty string
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code indicating the monitoring result

example200
  • integer between 100 and 599
  • must be a standard HTTP status code
dataobject
errorsobject
messagestring

Status message indicating the result of the monitoring operation

exampleSuccess
  • must be a non-empty string
  • typically a short status such as "Success"