Skip to main content

Attached Volume Monitoring

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

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 monitoring data retrieval.

    • must be a positive integer
    • value is expressed as seconds
    example3600
  • volume_idQuerystringoptional

    Identifier of the volume to monitor

    • required
    • must be a valid block or volume ID (e.g., UUID format)
    example{{block_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request

    • required
    • must be a non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Specifies the geographic location for the attached volume monitoring request.

    • must be a non-empty string
    • should be a valid location identifier (e.g., region code)
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code of the monitoring response

example200
  • integer
  • valid HTTP status code (100-599)
dataarray
errorsobject
messagestring

Status message indicating the result of the volume monitoring request

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