Skip to main content

List Snapshots

GET/api/v1/nodes/{node_id}/snapshots/

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 for authenticating the request

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

    Specifies the location/region for which snapshots are listed

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

Responses

200Successful response
object
codeinteger

HTTP status code of the list snapshots response

example200
  • integer
  • value between 100 and 599
dataarray
errorsobject
messagestring

Status message indicating the result of the list snapshots operation

exampleSuccess
  • non-empty string
  • max length 200 characters