Activate Backup / Activate CDP Backup

PUT

/api/v1/cdpbackup/activate/{node_id}/

curl --request PUT \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/cdpbackup/activate/{node_id}/?project_id=<PROJECT_ID>&apikey=<API_KEY>&location=<LOCATION>' \
  --header 'Authorization: Bearer <API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "plan_id": 1,
  "type": "HOURLY",
  "exclude_file_folder": "",
  "backup_now": true,
  "compression_type": "ZLib",
  "is_encryption_required": false,
  "compression_level": "Low",
  "hoursOfDay": "0,6,12,18",
  "startingMinute": 38,
  "db_enabled": "",
  "db_username": "",
  "db_password": ""
}'

import requests

response = requests.put(
    "https://api.e2enetworks.com/myaccount/api/v1/cdpbackup/activate/{node_id}/",
    params={"project_id": "<PROJECT_ID>", "apikey": "<API_KEY>", "location": "<LOCATION>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "plan_id": 1,
        "type": "HOURLY",
        "exclude_file_folder": "",
        "backup_now": True,
        "compression_type": "ZLib",
        "is_encryption_required": False,
        "compression_level": "Low",
        "hoursOfDay": "0,6,12,18",
        "startingMinute": 38,
        "db_enabled": "",
        "db_username": "",
        "db_password": "",
    },
)
print(response.json())

const url = new URL("https://api.e2enetworks.com/myaccount/api/v1/cdpbackup/activate/{node_id}/");
url.search = new URLSearchParams({ project_id: "<PROJECT_ID>", apikey: "<API_KEY>", location: "<LOCATION>" });

const response = await fetch(url, {
  method: "PUT",
  headers: { "Authorization": "Bearer <API_TOKEN>", "Content-Type": "application/json" },
  body: JSON.stringify({
    "plan_id": 1,
    "type": "HOURLY",
    "exclude_file_folder": "",
    "backup_now": true,
    "compression_type": "ZLib",
    "is_encryption_required": false,
    "compression_level": "Low",
    "hoursOfDay": "0,6,12,18",
    "startingMinute": 38,
    "db_enabled": "",
    "db_username": "",
    "db_password": ""
  }),
});
console.log(await response.json());

curl --request PUT \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/cdpbackup/activate/{node_id}/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
  --header 'Authorization: Bearer <API_TOKEN>'

import requests

response = requests.put(
    "https://api.e2enetworks.com/myaccount/api/v1/cdpbackup/activate/{node_id}/",
    params={"project_id": "<PROJECT_ID>", "location": "<LOCATION>", "apikey": "<API_KEY>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
print(response.json())

const url = new URL("https://api.e2enetworks.com/myaccount/api/v1/cdpbackup/activate/{node_id}/");
url.search = new URLSearchParams({ project_id: "<PROJECT_ID>", location: "<LOCATION>", apikey: "<API_KEY>" });

const response = await fetch(url, {
  method: "PUT",
  headers: { "Authorization": "Bearer <API_TOKEN>" },
});
console.log(await response.json());

Enables CDP Backup for a node. Refused with “CDP Backup Cannot Be Enabled — The selected security group does not have TCP port 1167 open, which is required for CDP Backup agent communication” unless the node’s security group has that port open. Billed as a flat license fee (₹900 or $10 per month) plus ₹2.5 or $0.03 per GB of backup storage per month; the first backup runs, and every backup after it, every 6 hours by default.

Activate Backup and Activate CDP Backup share this request; the body you send decides which one runs.

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

Specifies the target location for activating the backup.

Example

<LOCATION>

Request Body

application/json

object

plan_id

Identifier of the backup plan to activate.

integer

Example

type

Specifies the backup activation schedule type.

string

Example

HOURLY

exclude_file_folder

Path or pattern of files/folders to exclude from the backup

string

Example

backup_now

Flag to trigger an immediate backup when true.

boolean

Example

true

compression_type

Specifies the compression algorithm to use for the backup.

string

Example

ZLib

is_encryption_required

Indicates whether encryption is required for the backup activation.

boolean

Example

false

compression_level

Specifies the desired compression intensity for the backup operation.

string

Example

Low

hoursOfDay

Hours of the day when the backup should run, expressed as a comma-separated list of 0-23 values

string

Example

0,6,12,18

startingMinute

Minute of the hour when backup activation should start

integer

Example

db_enabled

Indicates whether the database backup should be enabled

string

Example

db_username

Database username for authentication

string

Example

db_password

Database password used for backup activation

string

Example

Responses

200

Successful response

application/json

object

code

HTTP status code returned by the Activate Backup operation

integer

data

object

support_ticket_created

Indicates whether a support ticket was created during the backup activation

boolean

errors

object

message

Human-readable status message confirming activation of backup.

string

Example

{
  "code": 200,
  "data": {
    "support_ticket_created": true
  },
  "message": "Your backups will begin shortly."
}

default

Response