Create Plan Rule

Api to create plan rules. Request body will suggest plan against which rule need to be created and type of entities(workloads type, server groups, regions and all) that need to be referenced for applying that rule against a workload.

application/json

Request Body

• plan object required

  id int32

  name string
• rank int32

  Optional field to suggest priority/rank of the rule. If not present, we will process rule in the same order they are created.

• workloads object[]

  This will include list of apptypes that should be evaluated against workload apptype for plan association.

  id int32

  name string
• serverGroups object[]

  This will include list of Server groups that should be evaluated against workload server group for plan association.

  id int32

  name string
• regions object[]

  This will include list of regions that should be evaluated against workload region for plan association.

  id int32

  name string
• solutions object[]

  This will include list of solutions that should be evaluated against workload for plan association

  id int32

  name string
• company object

  id int32

  name string
• tags object[]

  This will include list of tags that should be evaluated against workload for plan association

  id int32

  Id for the tag

  name string

  Name for the plan rule tag which need to be matched against tag of the workload.

  value string

  Possible value that need to matched against value of tag associated to workload.

Responses

• 200
• 403
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• id int32
• name string

{
  "id": 0,
  "name": "string"
}

Forbidden

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/plan/rule    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

Body

{
  "plan": {
    "id": 0,
    "name": "string"
  },
  "rank": 0,
  "workloads": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "serverGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "regions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "solutions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "company": {
    "id": 0,
    "name": "string"
  },
  "tags": [
    {
      "id": 0,
      "name": "string",
      "value": "string"
    }
  ]
}

curl -L -X POST 'https://localhost/webconsole/api/V4/Plan/Rule' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "plan": {
    "id": 0,
    "name": "string"
  },
  "rank": 0,
  "workloads": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "serverGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "regions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "solutions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "company": {
    "id": 0,
    "name": "string"
  },
  "tags": [
    {
      "id": 0,
      "name": "string",
      "value": "string"
    }
  ]
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/Plan/Rule' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "plan": {
    "id": 0,
    "name": "string"
  },
  "rank": 0,
  "workloads": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "serverGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "regions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "solutions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "company": {
    "id": 0,
    "name": "string"
  },
  "tags": [
    {
      "id": 0,
      "name": "string",
      "value": "string"
    }
  ]
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/Plan/Rule' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "plan": {
    "id": 0,
    "name": "string"
  },
  "rank": 0,
  "workloads": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "serverGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "regions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "solutions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "company": {
    "id": 0,
    "name": "string"
  },
  "tags": [
    {
      "id": 0,
      "name": "string",
      "value": "string"
    }
  ]
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/Plan/Rule' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "plan": {
    "id": 0,
    "name": "string"
  },
  "rank": 0,
  "workloads": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "serverGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "regions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "solutions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "company": {
    "id": 0,
    "name": "string"
  },
  "tags": [
    {
      "id": 0,
      "name": "string",
      "value": "string"
    }
  ]
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/Plan/Rule' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "plan": {
    "id": 0,
    "name": "string"
  },
  "rank": 0,
  "workloads": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "serverGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "regions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "solutions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "company": {
    "id": 0,
    "name": "string"
  },
  "tags": [
    {
      "id": 0,
      "name": "string",
      "value": "string"
    }
  ]
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/Plan/Rule' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "plan": {
    "id": 0,
    "name": "string"
  },
  "rank": 0,
  "workloads": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "serverGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "regions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "solutions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "company": {
    "id": 0,
    "name": "string"
  },
  "tags": [
    {
      "id": 0,
      "name": "string",
      "value": "string"
    }
  ]
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/Plan/Rule' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "plan": {
    "id": 0,
    "name": "string"
  },
  "rank": 0,
  "workloads": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "serverGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "regions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "solutions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "company": {
    "id": 0,
    "name": "string"
  },
  "tags": [
    {
      "id": 0,
      "name": "string",
      "value": "string"
    }
  ]
}'