Skip to main content

Usage

GET/api/v1/cdpbackup/{node_id}/usage/

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
    • must be a valid non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Location filter for the usage query

    • Must be a non-empty string
    • Should be a valid location identifier (e.g., city name or ISO code)
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code of the usage response

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

Status message indicating the result of the request

exampleSuccess
  • non-empty string
  • maximum length 255 characters