Skip to main content

Update Schedule Action

PUT/api/v1/nodes/{node_id}/scheduled_actions/{action_id}/

Path parameters

  • node_idPathstringrequired

    Path parameter node_id.

  • action_idPathstringrequired

    Path parameter action_id.

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 to authenticate the request

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

    Location identifier for the schedule update

    • must be a non-empty string
    • should be a valid location code
    example{{location}}

Request body

application/json

object
timezonestring

IANA time zone identifier for the schedule

exampleAsia/Calcutta
  • must be a valid IANA time zone name
  • non-empty string
action_tagstring

Identifier of the schedule action to update

examplepow-off
  • must be a non-empty string
  • may contain only lowercase letters, numbers, and hyphens
actionstring

Specifies the action to perform when updating the schedule

examplepoweroff
  • must be a non-empty string
  • must be a supported action keyword such as "poweroff"
scheduled_typestring

Specifies the type of schedule being updated

exampleone_time
  • must be a non-empty string
  • allowed values: "one_time", "recurring"
one_timeobject

Responses

200Successful response
object
codeinteger

HTTP status code indicating the result of the update schedule action

example200
  • must be a valid HTTP status code (100-599)
  • 200 indicates success
datainteger

Integer identifier returned after updating a schedule

example12345
  • must be a non-negative integer
  • typically fits within 32-bit signed range
errorsobject
messagestring

Message indicating the result of the update schedule action.

examplesuccessfully updated scheduled action
  • must be a non-empty string
  • maximum length 255 characters