Skip to main content

Disable Scheduled Snapshots

DELETE/api/v1/schedule-snapshot/

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

    Specifies the type of service to disable scheduled snapshots for.

    • must be a non-empty string
    • allowed value: schedule
    exampleschedule
  • resource_idQuerystringoptional

    Identifier of the node whose scheduled snapshots are to be disabled

    • required
    • must be a valid node identifier (e.g., UUID or alphanumeric ID)
    example{{node_id}}
  • resource_typeQuerystringoptional

    Specifies the type of resource for which scheduled snapshots are disabled.

    • must be a non-empty string
    • allowed values include "node"
    examplenode
  • apikeyQuerystringoptional

    API key used to authenticate the request

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

    Specifies the target location for disabling scheduled snapshots.

    • must be a non-empty string
    • should match a supported location identifier (e.g., us-east, eu-west)
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code indicating the result of disabling scheduled snapshots

example200
  • must be an integer
  • 200 indicates success
dataobject
errorsobject
messagestring

Confirmation message indicating scheduled snapshots have been disabled.

exampleSchedule settings has been disabled successfully.
  • must be a non-empty string
  • should not exceed 200 characters