Skip to main content

Update Scheduled Snapshots

PUT/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}}
  • apikeyQuerystringrequired

    API key used to authenticate the request

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

    Specifies the E2E Myaccount region where the snapshot will be updated.

    • Must be a non-empty string
    • Should be a valid E2E Myaccount region identifier (e.g., eastus, westus2)
    example{{location}}

Request body

application/json

string

JSON string containing the scheduled snapshot update parameters

example{ "resource_id": {{node_id}}, "resource_type": "node", "time_line": 1, "create_after": "7", "delete_after": "3" }
  • must be a valid JSON object
  • must include resource_id, resource_type, time_line, create_after, and delete_after

Responses

200Successful response
object
codeinteger

HTTP status code of the update operation

example200
  • 3-digit HTTP status code
  • non-negative integer
dataobject
errorsobject
messagestring

Confirmation message indicating the update result.

exampleSchedule settings has been updated successfully.
  • must be a non-empty string
  • maximum length of 255 characters