Skip to main content

Create Snapshot

POST/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

    The target location or region for the snapshot.

    • required
    • must be a valid region identifier (e.g., us-east1)
    example{{location}}

Request body

application/json

object
namestring

Name of the snapshot to create

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

Responses

200Successful response
object
codeinteger

HTTP status code of the snapshot creation response

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

Status message indicating the result of the snapshot creation.

exampleSuccess
  • Must be a non-empty string
  • Maximum length typically 255 characters