Run backups on server plan associated entities

API to run backups on server plan associated entities

Path Parameters

• planId int32 required

  Id of the Server Plan

Query Parameters

• backupLevel string required

  Possible values: [INCREMENTAL, DIFFERENTIAL, FULL, SYNTHETIC_FULL]

  Backup level of jobs

Responses

• 200
• 401
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• taskId int32
• jobIds string[]

  JobIds for the immediate run request

{
  "taskId": 0,
  "jobIds": [
    "string"
  ]
}

Unauthorized

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

POST /v4/serverplan/:planid/backup/run    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

planId — path required

backupLevel — query required

---INCREMENTALDIFFERENTIALFULLSYNTHETIC_FULL

curl -L -X POST 'https://localhost/webconsole/api/V4/ServerPlan/:planId/Backup/Run' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X POST 'https://localhost/webconsole/api/V4/ServerPlan/:planId/Backup/Run' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X POST 'https://localhost/webconsole/api/V4/ServerPlan/:planId/Backup/Run' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X POST 'https://localhost/webconsole/api/V4/ServerPlan/:planId/Backup/Run' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X POST 'https://localhost/webconsole/api/V4/ServerPlan/:planId/Backup/Run' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X POST 'https://localhost/webconsole/api/V4/ServerPlan/:planId/Backup/Run' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X POST 'https://localhost/webconsole/api/V4/ServerPlan/:planId/Backup/Run' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'