Add Schedule Action

POST

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

curl --request POST \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/nodes/{node_id}/scheduled_actions/?project_id=<PROJECT_ID>&apikey=<API_KEY>&location=<LOCATION>' \
  --header 'Authorization: Bearer <API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "timezone": "Asia/Calcutta",
  "action_tag": "pow-off",
  "action": "poweroff",
  "scheduled_type": "periodic",
  "periodic": {
    "repeat": "weekly",
    "start_time": "2025-08-12 15:00:00",
    "end_type": "on",
    "repeat_period": "3",
    "end_time": "2025-08-13 12:00:00"
  }
}'

Parameters

Path Parameters

node_id

required

string

Path parameter node_id.

Query Parameters

project_id

required

integer

Identifier of the project to scope the request to. Required integer project ID.

Example

<PROJECT_ID>

apikey

required

string

API key used for authentication

Example

<API_KEY>

location

required

string

Location identifier for the schedule

Example

<LOCATION>

Request Body

Media typeapplication/json

object

timezone

Time zone identifier for the schedule

string

Example

Asia/Calcutta

action_tag

Identifier for the schedule action to perform

string

Example

pow-off

action

Specifies the schedule action to perform

string

Example

poweroff

scheduled_type

Specifies the type of schedule to add

string

Example

periodic

periodic

object

repeat

Recurrence interval for the schedule

string

Example

weekly

start_time

The start time of the schedule in local date-time format.

string

Example

2025-08-12 15:00:00

end_type

Specifies how the periodic schedule ends.

string

Example

on

repeat_period

Number of periods between schedule repetitions

string

Example

3

end_time

The ending timestamp of the schedule period.

string

Example

2025-08-13 12:00:00

Responses

200

Successful response

Media typeapplication/json

object

code

HTTP status code indicating the result of adding a schedule

integer

data

Identifier of the created schedule

integer

errors

object

message

Human-readable status message for the add schedule operation

string

Example

{
  "code": 200,
  "data": 123456,
  "message": "successfully added scheduled action to your virtual machine"
}