These docs are for v4.3. Click to read the latest docs for v4.5.

External APIs 4.0 (2302)

Changelog

What's New

  • GET/budget/{tenant_id}/{budget_id}/budget_history List Budget History
  • DELETE/budget/{tenant_id}/{budget_id}/delete Delete Budget
  • GET/budget/{tenant_id}/{budget_id}/view List Budget Detail
  • GET/cost/schedule_recommendation/resource/{tenant_id}/recommendation_summary List Schedule Recommendation Resource Dashboard Summary
  • GET/governance/account/{tenant_id}/validate_summary Cloud Accounts Summary
  • POST/governance/account/{tenant_id}/validate_summary Validate Cloud Account Auth Credentials
  • POST/cost/schedule_recommendation/dashboard/summary List Schedule Recommendation Account Dashboard Summary

What's Deprecated

  • GET/budget/{budget_id}/budget_history List Budget History
  • DELETE/budget/{budget_id}/delete Delete Budget
  • GET/budget/{budget_id}/view List Budget Detail
  • GET/cost/schedule_recommendation/resource/summary List Schedule Recommendation Resource Dashboard Summary
  • POST/governance/account/{tenant_id}/create/validate&summary Validate Cloud Account Auth Credentials
  • GET/governance/account/{tenant_id}/get/validate&summary Cloud Accounts Summary
  • GET/cost/schedule_recommendation/dashboard/summary List Schedule Recommendation Account Dashboard Summary
  • X-Auth-user should be passed in header while authorizing the API’s
  • Tenantid should be passed in header.

What's Changed

  • POST/budget/dashboard/budget_alert_exceeds_count View Count Budget Alert Exceeds Summary

📘

Parameter

  • Add BudgetSummaryReqModel.tenant_ids//Tenant ids
  • Change BudgetSummaryReqModel.type
  • POST/budget/dashboard/budget_summary_count View Count Budget Summary

📘

Parameter

  • Add BudgetSummaryReqModel.tenant_ids//Tenant ids
  • Change BudgetSummaryReqModel.type
  • POST/budget/dashboard/list_budgets View Budget Dashboard

📘

Parameter

  • Add BudgetListReqModel.tenant_ids//Tenant ids
  • Change BudgetListReqModel.cloud (Data Type)

📘

Return Type

  • Add budgets_list.last_threshold//last threshold
  • Add budgets_list.budget_engine//budget engine can be Cloud_Native or System
  • Add budgets_list.budget_scope//budget scope
  • Add budgets_list.budget_scope_details//scope of the budget further defined for each scope
  • GET/compliance/{tenant_id}/compliance_control_mapping/compliance_assessment_summary ComplianceControl Mapping Report

📘

Parameter

  • service_account_id Notes ID of the cloud account. This can be fetched from listcloudaccounts API change into ID of the cloud account. This can be fetched from ListCloudAccounts API
  • Change service_account_id
  • GET/compliance/{tenant_id}/compliance_standards/{cloud_account_id}/get_configurations List Compliance Configurations

📘

Parameter

  • cloud_account_id Notes ID of the cloud account. This can be fetched from listcloudaccounts API change into ID of the cloud account. This can be fetched from ListCloudAccounts API
  • Change cloud_account_id
  • GET/compliance/{tenant_id}/visibility List Compliance Visibility

📘

Parameter

  • cloud_account_id Notes ID of the cloud account. This can be fetched from listcloudaccounts API change into ID of the cloud account. This can be fetched from ListCloudAccounts API
  • Change cloud_account_id
  • PUT/cost/cost_savings/accounts/visibility/{tenant_id} List Cost Saving Recommendation

📘

Parameter

  • Add ListRecommendationsRequest
  • DeleteListRecommendationsRequestModel
  • PUT/cost/cost_savings/tenants/visibility/{tenant_id} List Cost Saving Recommendation by Tenant

📘

Parameter

  • Add ListRecommendationsTenantRequest
  • DeleteListRecommendationsTenantRequestModel
  • POST/cost/costoptimizer/optimizeusage/{tenant_id}/cloud_account_summary Overall Cloud Account Summary

📘

Parameter

  • Add CostOptimizationCloudAccountSummaryRequest
  • DeleteCostOptimizationReqCloudAccountSummary

📘

Return Type

  • Deleteaccount_summary.cloud_account_id//Cloud account id
  • Deleteaccount_summary.cloud_account_name//Cloud account name
  • Deleteaccount_summary.cloud_account_type//Cloud account type
  • Deleteaccount_summary.recommendation//Recommendations
  • Deleteaccount_summary.estimated_cost//Estimated cost
  • Deleteaccount_summary.monthly_cost_savings//Monthly cost savings
  • Deleteaccount_summary.quarterly_cost_savings//Quarterly cost savings
  • Deleteaccount_summary.yearly_cost_savings//Yearly cost savings
  • Deleteaccount_summary.impacted_resources//Impacted resources
  • Deleteaccount_summary.savings_percentage//Savings percentage
  • Deleteaccount_summary.monthly_cost_saving_info//Monthly cost saving information
  • Deleteaccount_summary.quarterly_cost_saving_info//Quarterly cost saving information
  • Deleteaccount_summary.yearly_cost_saving_info//Yearly cost saving information
  • POST/cost/costoptimizer/optimizeusage/{tenant_id}/cloud_account_type Cloud Account Details

📘

Parameter

  • Add CostOptimizationCloudAccountTypeRequest
  • DeleteCostOptimizationCloudAccTypeReqModel
  • POST/cost/costoptimizer/optimizeusage/{tenant_id}/view_recommendations Resource Wise Recommendation(Savings) Data

📘

Parameter

  • Add CostOptimizationViewRecommendationRequest
  • DeleteCostOptimizationReqViewRecommendation

📘

Return Type

  • Deleterecommendation_data.cloud_account_id//Cloud account id
  • Deleterecommendation_data.recommendation_id//Recommendation id
  • Deleterecommendation_data.resource_name//Resource name
  • Deleterecommendation_data.resource_type//Resource type
  • Deleterecommendation_data.resource_id//Resource id
  • Deleterecommendation_data.status//Status
  • Deleterecommendation_data.summary//Summary
  • Deleterecommendation_data.impact_level//Impact level
  • Deleterecommendation_data.estimated_cost//Estimated cost
  • Deleterecommendation_data.region//Region
  • Deleterecommendation_data.estimated_cost_saving//Estimated cost saving
  • Deleterecommendation_data.optimization_type//Optimization type
  • Deleterecommendation_data.recommended_sku//Recommended SKU
  • Delete~recommendation_data.current_sku~~//Current SKU
  • Deleterecommendation_data.savings_percentage//Savings percentage
  • Deleterecommendation_data.estimated_cost_saving_info//Estimated cost saving information
  • PUT/cost/discounts/{tenant_id}/create Create Cost Discount Rule

📘

Parameter

  • Add CreateMarkupsRequest.markup_type//Type of the discount. Example 'markup_type': 'percentage'
  • Add CreateMarkupsRequest.markup_percentage//Markup Percentage. Example 'markup_percentage': 35
  • DeleteCreateMarkupsRequest.discount_type//Type of the discount. Example 'discount_type': 'percentage'
  • DeleteCreateMarkupsRequest.discount_percentage//Discount Percentage. Example 'discount_percentage': 35
  • PUT/cost/markups/{tenant_id}/create Create Cost Markup Rule

📘

Parameter

  • Add CreateMarkupsRequest.markup_type//Type of the discount. Example 'markup_type': 'percentage'
  • Add CreateMarkupsRequest.markup_percentage//Markup Percentage. Example 'markup_percentage': 35
  • DeleteCreateMarkupsRequest.discount_type//Type of the discount. Example 'discount_type': 'percentage'
  • DeleteCreateMarkupsRequest.discount_percentage//Discount Percentage. Example 'discount_percentage': 35
  • DELETE/cost/markups_and_discounts/{tenant_id}/delete Delete Cost Markup Rule

📘

Parameter

  • rule_name change into required
  • Change rule_name
  • PUT/cost/ri_markups/{tenant_id}/create Create Cost RI-Markup Rule

📘

Parameter

  • Add CreateMarkupsRequest.markup_type//Type of the discount. Example 'markup_type': 'percentage'
  • Add CreateMarkupsRequest.markup_percentage//Markup Percentage. Example 'markup_percentage': 35
  • DeleteCreateMarkupsRequest.discount_type//Type of the discount. Example 'discount_type': 'percentage'
  • DeleteCreateMarkupsRequest.discount_percentage//Discount Percentage. Example 'discount_percentage': 35
  • GET/governance/account/{tenant_id}/compliance_standards/{cloud_account_id}/get_configurations Assessment Compliance Validation

📘

Parameter

  • cloud_account_id Notes ID of the cloud account. This can be fetched from listcloudaccounts API change into ID of the cloud account. This can be fetched from ListCloudAccounts API
  • Change cloud_account_id
  • POST/governance/account/{tenant_id}/create/{cloud_account_id}/assessment_validation_result Assessment Validation Details

📘

Parameter

  • Change AssessmentValidationRequestDataModel.validation_type
  • POST/governance/account/{tenant_id}/create/{cloud_account_id}/revalidate_assessment Assessment Re-Validation

📘

Parameter

  • Change AssessmentValidationRequestDataModel.validation_type
  • POST/operations/anomaly_detector/recommendations/{tenant_id}/list List Anomalies Recommendation

📘

Parameter

  • Add ListAnomalyRecommendationsRequest
  • DeleteListRecommendationsRequest
  • DELETE/resource/business_applications/applications/{tenant_id}/delete/{application_id} Delete Application in Business Application

📘

Parameter

  • application_id Notes specify the Application id of the Application to delete, Application id is unique can be obtained from the list Application api change into Specify the Application id of the Application to delete, Application id is unique can be obtained from the list Application api
  • Change application_id
  • POST/resource/locks/{tenant_id}/lock_config_rule Create Resource Lock Config Rule

📘

Parameter

  • Add CreateResourceLockRequest.filters.zone//List zone of cloud account
  • Change CreateResourceLockRequest.filters.regions
  • Change CreateResourceLockRequest.filters.resource_groups
  • GET/{tenant_id}/assessment_history Get compliance standard assessments

📘

Parameter

  • service_account Notes ID of the cloud account. This can be fetched from listcloudaccounts API change into ID of the cloud account. This can be fetched from ListCloudAccounts API
  • Change service_account