Skip to main content

Scheduled Snapshots

GET/api/v1/schedule-snapshot/

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}}
  • resource_idQuerystringoptional

    Identifier of the node for which to retrieve scheduled snapshots

    • required
    • non-empty string
    • valid node identifier
    example{{node_id}}
  • resource_typeQuerystringoptional

    Filter snapshots by the type of resource they belong to

    • must be a non-empty string
    • case-sensitive identifier of a resource type
    examplenode
  • apikeyQuerystringrequired

    API key used to authenticate the request

    • required
    • must be a valid API key string
    example{{api_key}}
  • locationQuerystringrequired

    Specifies the E2E Myaccount region for the scheduled snapshot.

    • non-empty string
    • must be a valid E2E Myaccount location identifier
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code of the scheduled snapshot response

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

Status message indicating the result of the snapshot operation.

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