Skip to main content

Run Cost assessment with the given credential / refresh token​

Select

SaaS
Customer Managed

Run Cost assessment with the given credential / refresh token

Request Body
  • assessmentName string

    Assessment Name

  • assessmentId string

    Assessment Id

  • authType TCOCredentialAuthType

    Possible values: [OAUTH2, CREDENTIAL_VAULT]

    Default value: CREDENTIAL_VAULT

    Supported Credential Authentication Types for Cyber Resilience Cost Assessment Dashboard

  • cloudProvider CyberResiliencyCloudConnector

    Possible values: [AZURE, AWS, GCP, M365, AD]

    Default value: AZURE

    Supported Connector Types for Cyber Resilience Cost Assessment Dashboard

  • assessmentProperties object
  • credentialId int32
  • cloudConnector CyberResiliencyCloudConnector

    Possible values: [AZURE, AWS, GCP, M365, AD]

    Default value: AZURE

    Supported Connector Types for Cyber Resilience Cost Assessment Dashboard

  • authType TCOCredentialAuthType

    Possible values: [OAUTH2, CREDENTIAL_VAULT]

    Default value: CREDENTIAL_VAULT

    Supported Credential Authentication Types for Cyber Resilience Cost Assessment Dashboard

  • discoveryCriteria object

    Model for Workload Discovery Selector Object

  • criteria WorkloadDiscoveryCriteriaEnum

    Possible values: [SUBSCRIPTIONS, REGIONS, PROJECTS, ZONES]

    Selection criteria for workload discovery while running a TCO Assessment

  • details object[]

    Additional Details related to respective select

  • id int32
  • name string
  • value string
  • assessmentConfig object

    TCO Assessment Configuration Fields

  • utilizationFactorVM float

    Virtual Machine Utilization Percentage

  • standardRetention float

    Standard Retention in Days for Workloadd

  • annualGrowthRate float

    Annual Projected Growth Rate for Workload

  • dailyChangeRateVM float
  • dailyChangeRateDB float
  • dailyChangeRateFO float
  • storageReplicationTarget float
  • workloadDetails object[]
  • costdetails object[]
  • name string
  • value string
  • resourceDetails object[]
  • resourcetype string

    Type of the resource

  • count int32

    Number of resources of this type

  • resourceSize int64

    Sum of the size of all the resources of this type

  • details object[]
  • resourceName string
  • resourceProperties object[]
  • name string
  • value string
  • workloadtype string
  • discoveredCount int32

    Total Count of Workload Resources

  • discoveredSize int64

    Total Size In Bytes for Discovered Resources

  • commvaultCost object
  • primarySnapshotStorageCost int64
  • secondarySnapshotStorageCost int64
  • asrTotalVMEnvironment int64
  • primaryCloudStorageUsedCost int64
  • primaryCloudStorageUsed3YCost int64
  • secondaryCloudStorageUsedCost int64
  • secondaryCloudStorageUsed3YCost int64
  • protectionCost int64
  • primaryInfraCost int64
  • secondaryInfraCost int64
  • dataTranmissionCost int64
  • numberOfVirtualMachines int32 required

    Total number of Virtual Machines that are included for TCO assessment

  • totalVirtualMachineSize int64 required

    Total size of Virtual Machines in GB that are included for TCO assessment

  • totalRecoveryPoints int32 required

    Total number of Recovery Points that are included for TCO assessment

  • totalInstantRestoreSnapshot int32 required

    Total number of Instant Restore Snapshots that are included for TCO assessment

  • dailyRateOfChange int32 required

    This is the predicted rate of change that impacts the snapshot size and backup size

  • replicatedSnapsPercentage int32 required

    This is the total percentage of snapshots replicated that is included for TCO assessment

  • nativeDiscountPercentage int32

    This is the percentage of the discount that the customer gets with the cloud vendor

  • commvaultDiscountPercentage int32

    This is the percentage of the discount that the customer gets with Commvault

  • credentialId int32

    Credential Id to be used to run assessment

Responses

OK

Schema
  • assessmentId string

    Assessment Id

  • assessmentName string

    Assessment Name

  • commvault object
  • primarySnapshotStorageCost int64
  • secondarySnapshotStorageCost int64
  • asrTotalVMEnvironment int64
  • primaryCloudStorageUsedCost int64
  • primaryCloudStorageUsed3YCost int64
  • secondaryCloudStorageUsedCost int64
  • secondaryCloudStorageUsed3YCost int64
  • protectionCost int64
  • primaryInfraCost int64
  • secondaryInfraCost int64
  • dataTranmissionCost int64
  • native object
  • primarySnapshotStorageCost int64
  • secondarySnapshotStorageCost int64
  • asrTotalVMEnvironment int64
  • primaryCloudStorageUsedCost int64
  • primaryCloudStorageUsed3YCost int64
  • secondaryCloudStorageUsedCost int64
  • secondaryCloudStorageUsed3YCost int64
  • protectionCost int64
  • primaryInfraCost int64
  • secondaryInfraCost int64
  • dataTranmissionCost int64
  • errorCode CyberResilienceErrorCode

    Possible values: [NO_ERROR, INVALID_INPUT, INDEX_SERVER_NOT_EXIST, INDEX_SERVER_INACCESSIBLE, INDEX_SERVER_DATA_ANALYTICS_ROLE_MISSING, CREDENTIAL_UNSUPPORTED, CREDENTIAL_INACCESSIBLE, CYBER_RESILIENCE_ALREADY_CONFIGURED, CYBER_RESILIENCE_NOT_CONFIGURED, DELETING_UNCONFIGURED_CREDENTIAL, ADDING_CONFIGURED_CREDENTIAL, UNKNOWN_ERROR, INTERNAL_SERVER_ERROR, CREDENTIAL_INVALID]

  • errorMessage string
POST /v4/tco/assessment

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "assessmentName": "string",

  "assessmentId": "string",

  "authType": "CREDENTIAL_VAULT",

  "cloudProvider": "AZURE",

  "assessmentProperties": {

    "credentialId": 0,

    "cloudConnector": "AZURE",

    "authType": "CREDENTIAL_VAULT",

    "discoveryCriteria": {

      "criteria": "SUBSCRIPTIONS",

      "details": [

        {

          "id": 0,

          "name": "string",

          "value": "string"

        }

      ]

    },

    "assessmentConfig": {

      "utilizationFactorVM": 0,

      "standardRetention": 0,

      "annualGrowthRate": 0,

      "dailyChangeRateVM": 0,

      "dailyChangeRateDB": 0,

      "dailyChangeRateFO": 0,

      "storageReplicationTarget": 0

    },

    "workloadDetails": [

      {

        "costdetails": [

          {

            "name": "string",

            "value": "string"

          }

        ],

        "resourceDetails": [

          {

            "resourcetype": "string",

            "count": 0,

            "resourceSize": 0,

            "details": [

              {

                "resourceName": "string",

                "resourceProperties": [

                  {

                    "name": "string",

                    "value": "string"

                  }

                ]

              }

            ]

          }

        ],

        "workloadtype": "string",

        "discoveredCount": 0,

        "discoveredSize": 0

      }

    ],

    "commvaultCost": {

      "primarySnapshotStorageCost": 0,

      "secondarySnapshotStorageCost": 0,

      "asrTotalVMEnvironment": 0,

      "primaryCloudStorageUsedCost": 0,

      "primaryCloudStorageUsed3YCost": 0,

      "secondaryCloudStorageUsedCost": 0,

      "secondaryCloudStorageUsed3YCost": 0,

      "protectionCost": 0,

      "primaryInfraCost": 0,

      "secondaryInfraCost": 0,

      "dataTranmissionCost": 0

    }

  },

  "numberOfVirtualMachines": 0,

  "totalVirtualMachineSize": 0,

  "totalRecoveryPoints": 0,

  "totalInstantRestoreSnapshot": 0,

  "dailyRateOfChange": 0,

  "replicatedSnapsPercentage": 0,

  "nativeDiscountPercentage": 0,

  "commvaultDiscountPercentage": 0,

  "credentialId": 0

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/TCO/Assessment' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "assessmentName": "string",
  "assessmentId": "string",
  "authType": "CREDENTIAL_VAULT",
  "cloudProvider": "AZURE",
  "assessmentProperties": {
    "credentialId": 0,
    "cloudConnector": "AZURE",
    "authType": "CREDENTIAL_VAULT",
    "discoveryCriteria": {
      "criteria": "SUBSCRIPTIONS",
      "details": [
        {
          "id": 0,
          "name": "string",
          "value": "string"
        }
      ]
    },
    "assessmentConfig": {
      "utilizationFactorVM": 0,
      "standardRetention": 0,
      "annualGrowthRate": 0,
      "dailyChangeRateVM": 0,
      "dailyChangeRateDB": 0,
      "dailyChangeRateFO": 0,
      "storageReplicationTarget": 0
    },
    "workloadDetails": [
      {
        "costdetails": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "resourceDetails": [
          {
            "resourcetype": "string",
            "count": 0,
            "resourceSize": 0,
            "details": [
              {
                "resourceName": "string",
                "resourceProperties": [
                  {
                    "name": "string",
                    "value": "string"
                  }
                ]
              }
            ]
          }
        ],
        "workloadtype": "string",
        "discoveredCount": 0,
        "discoveredSize": 0
      }
    ],
    "commvaultCost": {
      "primarySnapshotStorageCost": 0,
      "secondarySnapshotStorageCost": 0,
      "asrTotalVMEnvironment": 0,
      "primaryCloudStorageUsedCost": 0,
      "primaryCloudStorageUsed3YCost": 0,
      "secondaryCloudStorageUsedCost": 0,
      "secondaryCloudStorageUsed3YCost": 0,
      "protectionCost": 0,
      "primaryInfraCost": 0,
      "secondaryInfraCost": 0,
      "dataTranmissionCost": 0
    }
  },
  "numberOfVirtualMachines": 0,
  "totalVirtualMachineSize": 0,
  "totalRecoveryPoints": 0,
  "totalInstantRestoreSnapshot": 0,
  "dailyRateOfChange": 0,
  "replicatedSnapsPercentage": 0,
  "nativeDiscountPercentage": 0,
  "commvaultDiscountPercentage": 0,
  "credentialId": 0
}'