Skip to main content

Save Image from Snapshot

POST/api/v1/nodes/{node_id}/snapshot/{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 for authentication

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

    Specifies where the saved image should be stored.

    • required
    • must be a valid URL or file path
    example{{location}}

Request body

application/json

object
namestring

Identifier for the saved image derived from a snapshot.

exampleimage-from-snapshot-1234
  • required
  • must contain only alphanumeric characters and hyphens

Responses

200Successful response
object
codeinteger

HTTP status code indicating the result of the Save Image from Snapshot operation

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

Status message indicating the result of the save operation

exampleSuccess
  • Must not be empty
  • Maximum length 255 characters