Skip to main content

Get Snapshots

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

Path parameters

  • node_idPathstringrequired

    Path parameter node_id.

  • snapshot_uuidPathstringrequired

    Path parameter snapshot_uuid.

Query parameters

  • project_idQuerystringoptional

    Identifier of the project to scope the request to. Optional; if omitted, the account's default project is used.

    • optional
    • if omitted, the request is applied to the default project
    example{{project_id}}
  • apikeyQuerystringoptional

    API key used to authenticate the request

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

    Specifies the E2E Myaccount region for which snapshots are retrieved.

    • must be a valid E2E Myaccount location identifier (e.g., 'eastus')
    • cannot be empty
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code indicating the result of the Get Snapshots request

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

Status message indicating the result of the request

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