Process list of entities against plan rules.

API to send request to process plan rules against specific set of entities.

application/json

Request Body

Request body will consist of entities that are need to be evaluated against plan rules.

• subclients object[]

  List of subclients against which plan rules need to be executed and evaluated.

  id int32

  name string
• backupsets object[]

  List of backupsets against which plan rules need to be executed and evaluated.

  id int32

  name string
• instances object[]

  List of instances against which plan rules need to be executed and evaluated.

  id int32

  name string
• clients object[]

  List of clients against which plan rules need to be executed and evaluated.

  id int32

  name string
• ignorePreviousPlanAssociation boolean

  Boolean to indicate if we want to evaluate rule for entities associated to plan. Default is false. Only entities with no plan associated will be evaluated.

• isPreviewOnly boolean

  Boolean to indicate if request is to preview list of subclients that will be associated via plan rules

Responses

• 200
• 500

---

OK

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
}

PUT /v4/plan/rule/entities    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

Body

{
  "subclients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "backupsets": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "instances": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "clients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "ignorePreviousPlanAssociation": true,
  "isPreviewOnly": true
}

curl -L -X PUT 'https://localhost/webconsole/api/V4/Plan/Rule/Entities' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subclients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "backupsets": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "instances": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "clients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "ignorePreviousPlanAssociation": true,
  "isPreviewOnly": true
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/Plan/Rule/Entities' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subclients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "backupsets": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "instances": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "clients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "ignorePreviousPlanAssociation": true,
  "isPreviewOnly": true
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/Plan/Rule/Entities' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subclients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "backupsets": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "instances": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "clients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "ignorePreviousPlanAssociation": true,
  "isPreviewOnly": true
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/Plan/Rule/Entities' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subclients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "backupsets": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "instances": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "clients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "ignorePreviousPlanAssociation": true,
  "isPreviewOnly": true
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/Plan/Rule/Entities' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subclients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "backupsets": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "instances": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "clients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "ignorePreviousPlanAssociation": true,
  "isPreviewOnly": true
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/Plan/Rule/Entities' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subclients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "backupsets": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "instances": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "clients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "ignorePreviousPlanAssociation": true,
  "isPreviewOnly": true
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/Plan/Rule/Entities' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subclients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "backupsets": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "instances": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "clients": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "ignorePreviousPlanAssociation": true,
  "isPreviewOnly": true
}'