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

External APIs 4.3 (2401) - What's Changed Part-I

What's Changed

  • GET/access/posture/governance_summary/list Get Access Summary Count

📘

Parameter

  • Change services
  • GET/access/posture/governance_summary_dashboard Get Access Summary Dashboard Count

📘

Parameter

  • Change services

📘

Return Type

  • Change service_name
  • GET/access/posture/view_violations Get Access Violations

📘

Parameter

  • Change services
  • POST/access/visibility/details Get Access Detail

📘

Parameter

  • Change services
  • GET/access/visibility/filter Get Access Visibility Filter

📘

Parameter

  • Change services
  • POST/budget/create Create Budget

📘

Parameter

  • Add BudgetCreateUpdateRequest

  • DeleteBudgetCreateUpdateReqModel

📘

Return Type

  • Deletemessage//budget create/update success message
  • POST/budget/dashboard/budget_alert_exceeds_count View Count Budget Alert Exceeds Summary

📘

Parameter

  • Add BudgetSummaryRequest
  • DeleteBudgetSummaryReqModel
  • POST/budget/dashboard/budget_summary_count View Count Budget Summary

📘

Parameter

  • Add BudgetSummaryRequest
  • DeleteBudgetSummaryReqModel
  • POST/budget/dashboard/list_budgets View Budget Dashboard

📘

Parameter

  • Add BudgetListRequest

  • DeleteBudgetListReqModel

📘

Return Type

  • Change budgets_list.budget_scope_details.clouds
  • POST/budget/filter_values View Create Budget Advanced Filters

📘

Parameter

  • Add BudgetListConstraintsRequest
  • DeleteBudgetListConstraintsReqModel
  • PUT/budget/update Update Budget

📘

Parameter

  • Add BudgetCreateUpdateRequest

  • DeleteBudgetCreateUpdateReqModel

📘

Return Type

  • Deletemessage//budget create/update success message
  • DELETE/budget/{tenant_id}/{budget_id}/delete Delete Budget

📘

Return Type

  • Deletemessage//Response message.
  • GET/budget/{tenant_id}/{budget_id}/view List Budget Detail

📘

Return Type

  • Deletesummary.budget_details.filters.environment//environment with id name
  • Deletesummary.budget_details.filters.application//application with id name
  • Deletesummary.budget_details.filters.application_group//application_group with id name
  • Deletesummary.budget_details.filters.cost_center//cost_center with id name
  • GET/compliance/compliance_control_mapping/assessment_summary_by_job Get compliance assessment summary by assessment job number

📘

Return Type

  • Deletecategorized_count.violations//Number of policies which are in violation status.
  • Deletecategorized_count.success//Number of policies which are in success status.
  • Deletecategorized_count.error//Number of policies which are in error status.
  • Deletecategorized_count.in_progress//Number of policies which are in in_progress status.
  • Deletecategorized_count.none//Number of policies which are not having any status or in none status
  • POST/compliance/executive_dashboard/compliance Compliance Security Dashboard Summary

📘

Parameter

  • Change SecurityDashboardRequest.filter.clouds
  • POST/compliance/executive_dashboard/control_health Compliance Control Health by Control Categories

📘

Parameter

  • Change SecurityDashboardRequest.filter.clouds
  • POST/compliance/executive_dashboard/risk Compliance Risks By Cloud Accounts

📘

Parameter

  • Change SecurityDashboardRequest.filter.clouds
  • GET/compliance/{tenant_id}/assessment_history/list List Compliance Control Assessment History

📘

Return Type

  • Add total_count//Number of controls in the standard
  • Add page_count//Page number
  • Add assessment_history//list of assessment history entries.
  • DeleteTotal_count//Number of controls in the standard
  • DeleteAssessment_records//list of assessment history enteries.
  • POST/compliance/{tenant_id}/compliance_control_mapping/get_assessment_job_details List compliance control mapping, get_assessment_job_details

📘

Parameter

  • Add PolicyJobExecutionStatusRequest

  • DeletePolicyJobExecutionStatusRequestModel

📘

Return Type

  • Change total_count
  • Change page_count
  • GET/compliance/{tenant_id}/compliance_control_mapping/get_on_audit_entries List compliance control mapping, get_on_audit_entries

📘

Return Type

  • Change total_count
  • POST/compliance/{tenant_id}/control_mapping/on_demand_execute_control Compliance On Demand Control_execute

📘

Parameter

  • Add ComplianceControlRequest
  • DeleteComplianceControlReqModel
  • POST/compliance/{tenant_id}/control_mapping/on_demand_execute_standard Compliance On Demand Standard_execute

📘

Parameter

  • Add ComplianceStandardRequest
  • DeleteComplianceStandardReqModel
  • GET/compliance/{tenant_id}/controls/list List Compliance Controls

📘

Parameter

  • tenant_id Notes Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. change into Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
  • Change tenant_id
  • GET/compliance/{tenant_id}/standards List Compliance Standards

📘

Parameter

  • Change valid_service_type

📘

Return Type

  • Add data.id//ID
  • Deletedata._id//ID
  • POST/compliance_posture/detail_for_policy/{policy_id} List Compliance posture DetailsForPolicies

📘

Parameter

  • Add ComplianceDetailsForPoliciesRequest

  • DeleteComplianceDetailsForPoliciesReqModel

📘

Return Type

  • Deletestatus//success
  • Deletemessage//Compliance Posture Details For Policies
  • GET/compliance_posture/filters/by_policy List Compliance Filter For Heatstack

📘

Return Type

  • Deletestatus//success
  • Deletemessage//compliance posture filters
  • POST/compliance_posture/summary_by_accounts List compliance_posture summary_by_accounts

📘

Parameter

  • Add ComplianceSummaryRequest

  • DeleteComplianceSummaryReqModel

📘

Return Type

  • Add total_count
  • Add page_count//page count
  • Add page//page
  • Add records//records
  • Deletestatus//success
  • Deletemessage//compliance posture summary by cloud accounts
  • Deletedata//Data of Compliance posture summary by cloud accounts
  • POST/compliance_posture/summary_by_policies List Compliance posture SummaryByPolicies

📘

Parameter

  • Add ComplianceSummaryByPoliciesRequest

  • DeleteComplianceSummaryByPoliciesReqModel

📘

Return Type

  • Deletestatus//success
  • Deletemessage//Compliance Posture By Policy
  • POST/cost/cost_savings/{tenant_id}/resolve_recommendation/{recommendation_id} Resolve Cost Savings Recommendations

📘

Parameter

  • Add ResolveCostSavingsRecommendationsRequest

  • DeleteResolveRecommendationsRequest

📘

Return Type

  • Deletestatus//Status code of the resolve recommendation call
  • Deletemessage//Response message of the resolve recommendation call
  • POST/cost/costoptimizer/optimizerate/license_benefit/hub_discounts License Benefit Hub Discounts

📘

Parameter

  • Change LicenseBenefitHubDiscountsRequest.cloud_provider (Added Enum)

📘

Return Type

  • Change summary_data.cloud_provider (Added Enum)
  • POST/cost/costoptimizer/optimizerate/license_benefit/saving_summary License Benefit Cost Savings Summary

📘

Parameter

  • Change LicenseBenefitSavingRequest.service_names
  • POST/cost/costoptimizer/optimizeusage/{tenant_id}/cloud_account_summary Overall Cloud Account Summary

📘

Return Type

  • Deletestatus//Response status on Account Summary
  • Deletemessage//Account Summary
  • GET/cost/costoptimizer/optimizeusage/{tenant_id}/cloud_accounts View Cloud Account_ID and Cloud Account Name

📘

Parameter

  • Change service_name
  • GET/cost/costoptimizer/optimizeusage/{tenant_id}/filter View Tenant Wise Currency's Or Cloud Account Type

📘

Parameter

  • Change service_name

📘

Return Type

  • Deletestatus//Response status on cloud account type and currency
  • Deletemessage//Cost optimization filter fetched successfully
  • GET/cost/costoptimizer/optimizeusage/{tenant_id}/summary Tenant Wise Cost Summary

📘

Parameter

  • Change service_name

📘

Return Type

  • Deletestatus//Response status on cost dashboard summary
  • Deletemessage//List dashboard summary
  • POST/cost/costoptimizer/optimizeusage/{tenant_id}/view_recommendations Resource Wise Recommendation(Savings) Data

📘

Return Type

  • Deletestatus//Response status on policy recommendation view
  • Deletemessage//Policy Recommendation View
  • POST/cost/executive_dashboard/cloud_forecaster_for_six_months Get cloud Forecaster for six months

📘

Parameter

  • Change CloudForecasterForSixMonthsRequest.filter.clouds

📘

Return Type

  • Change cloud (Added Enum)
  • POST/cost/executive_dashboard/cost_optimization_by_optimization_types cost optimization by optimization type

📘

Parameter

  • Change CostOptimizationByOptimizationTypesRequest.filter.clouds

📘

Return Type

  • Change cloud_provider (Added Enum)
  • POST/cost/executive_dashboard/cost_optimization_trend Get cost optimization trend

📘

Parameter

  • Change CostOptimizationTrendRequest.filter.clouds

📘

Return Type

  • Change cloud (Added Enum)
  • POST/cost/executive_dashboard/cost_trend_by_cloud Get Cost Trend By Cloud

📘

Return Type

  • Change cloud (Added Enum)
  • POST/cost/executive_dashboard/spend-by-billing-type Get Cost Spend By Billing Type

📘

Return Type

  • Change cloud (Added Enum)
  • POST/cost/executive_dashboard/spend-by-cloud Get Cost Spend By Cloud

📘

Return Type

  • Change cloud (Added Enum)
  • POST/cost/executive_dashboard/spend-by-cloud-account Get Cost Spend By Cloud Account

📘

Return Type

  • Change cloud (Added Enum)
  • POST/cost/executive_dashboard/spend_by_cloud_resource_category Get Cost Spend By Cloud and Resource Category

📘

Return Type

  • Change cloud (Added Enum)
  • POST/cost/executive_dashboard/spend_by_cloud_tenant Get Cost Spend By Cloud and Tenant

📘

Return Type

  • Change cloud (Added Enum)
  • POST/cost/executive_dashboard/spend_by_region Get Cost Spend By Region

📘

Return Type

  • Change cloud (Added Enum)
  • POST/cost/executive_dashboard/tagged_and_untagged_spend_by_cloud Get Tagged and Untagged Spend Cloud Wise

📘

Parameter

  • Add TaggedAndUntaggedResourceByCloudRequest
  • DeleteTaggedAndUntaggedResourceByCloudRequestModel

📘

Return Type

  • Deletecloud.cloud_account_id//cloud account id
  • Deletecloud.tagged_spend//cost spend cloud wise for tagged
  • Deletecloud.tagged_count//tagged resource count
  • Deletecloud.untagged_spend//cost spend cloud wise for untagged
  • Deletecloud.untagged_count//untagged resource count
  • Deleteproduct_category.resource_type//resource type name
  • Deleteproduct_category.product_category//product category name
  • Deleteproduct_category.tagged_spend//tagged cost spend by product category
  • Deleteproduct_category.tagged_count//tagged resource count
  • Deleteproduct_category.untagged_spend//untagged cost spend by product category
  • Deleteproduct_category.untagged_count//untagged resource count
  • Deleteregion.cloud_account_id//service account id
  • Deleteregion.region//region name
  • Deleteregion.tagged_spend//region wise spend on tag
  • Deleteregion.tagged_count//tagged resource count
  • Deleteregion.untagged_spend//region wise spend on untagged
  • Deleteregion.untagged_count//untagged resource count
  • POST/cost/executive_dashboard/tagged_untagged_trend_cost_trend Get Tag And Untag Cloudwise Trend

📘

Parameter

  • Add TaggedAndUntaggedCostTrendRequest
  • DeleteTaggedAndUntaggedCostTrendRequestModel
  • GET/cost/markups_and_discounts/{tenant_id}/list List Cost Markup Rules

📘

Return Type

  • Change service (Added Enum)
  • PUT/cost/posture/account_or_tenant/visibility/cloud_usage_summary List Visibility Summary by Cloud Account Usage

📘

Parameter

  • Change ListIdentifierWiseRequest.service_name (Added Enum)
  • PUT/cost/posture/account_or_tenant/visibility/identifier_wise_cost List Visibility Summary by Identifier

📘

Parameter

  • Change ListIdentifierWiseRequest.service_name (Added Enum)
  • PUT/cost/posture/accounts List Dashboard Summary by Account

📘

Parameter

  • Add CostSummaryRequest
  • DeleteCostSummaryReqModel
  • POST/cost/posture/dashboard_summary List Dashboard Summary by Account, Tenant, Service type

📘

Parameter

  • Change CostDashboardSummaryRequest.cost_with_markup
  • Change CostDashboardSummaryRequest.filter.account_type
  • Change CostDashboardSummaryRequest.filter.service_type
  • Change CostDashboardSummaryRequest.by_billing_freq

📘

Return Type

  • Change account_usage.service_type (Added Enum)
  • PUT/cost/posture/ea_view_or_csp_view List Dashboard by Identifier

📘

Parameter

  • Add CostSummaryEAOrCSPRequest
  • DeleteCostSummaryEAOrCSPReqModel
  • PUT/cost/posture/ea_view_or_csp_view/visibility List Dashboard by EA or CSP View For Visibility

📘

Parameter

  • Add CostSummaryEAOrCSPVisibilityRequest
  • DeleteCostSummaryEAOrCSPVisibilityReqModel
  • PUT/cost/posture/tenants List Dashboard Summary by Tenant

📘

Parameter

  • DeleteCostSummaryReqModelTenant.filter.account_type//Type of cloud_account_type. Example 'account_type':['master_account','linked_account','Pay_as_You_Go',Azure_CSP-Direct','Azure_CSP-InDirect','Enterprise','billing_account',linked_project_account']
  • DeleteCostSummaryReqModelTenant.filter.cloud_service//The name of the cloud service.for example, Azure,GCP,AWS.
  • DeleteCostSummaryReqModelTenant.filter.total_cost//Total cost for the usage.example range from:0, to:1000000
  • DeleteCostSummaryReqModelTenant.filter.projected_cost//Projected cost. example range from:0, to:1000000
  • GET/cost/posture/{tenant_id}/get_cost_hierarchy Get Cost Hierarchy

📘

Parameter

  • service Notes cloud service name change into Select one from the supported services to display summary for that particular service
  • Change service

📘

Return Type

  • Deletestatus//Response status
  • Deletemessage//Response Message
  • POST/cost/ri/recommendation List Recommendations

📘

Parameter

  • Change ListRIRecommendationsRequest.services
  • GET/cost/ri/utilization/reservations List Cost Reservations & Utilization

📘

Parameter

  • date_filter Notes specify the date filter for which to fetch the data change into Date Filter to select
  • Change service
  • Change date_filter
  • GET/cost/ri/utilization/{cloud_account_id}/reservations/{reservation_id} List Cost Reservations & Utilization by Cloud Account

📘

Parameter

  • date_filter Notes specify the date filter for which to fetch the data change into Date Filter to select
  • Change date_filter
  • POST/cost/schedule_recommendation/dashboard/summary List Schedule Recommendation Account Dashboard Summary

📘

Parameter

  • Change ScheduleDashboardSummaryRequest.service_name
  • GET/cost/schedule_recommendation/resource/{tenant_id}/recommendation_summary List Schedule Recommendation Resource Dashboard Summary

📘

Parameter

  • Change service_name
  • POST/cost/service/filters List Service Filters

📘

Parameter

  • Add CostServiceFilterRequest
  • DeleteCostServiceFilterRequestModel
  • POST/cost_anomaly/billing_cost_anomaly Get Account wise daily Billing Cost Anomaly

📘

Parameter

  • Change CostAnomalySummaryRequest.filter.clouds
  • POST/cost_anomaly/rule_based_cost_anomaly Get Account wise daily Rule Cost Anomaly

📘

Parameter

  • Change CostAnomalySummaryRequest.filter.clouds
  • POST/governance/account/settings/access/post/{tenant_id} Assessment Validation

📘

Parameter

  • Change AssessmentValidationRequest.category
  • POST/governance/account/{tenant_id}/cloud_account/{cloud_account_id}/config_validation Config Validation Details

📘

Parameter

  • Change ConfigValidationRequest.policy_engine (Removed Enum)
  • Change ConfigValidationRequest.service_name (Added Enum)
  • PUT/governance/account/{tenant_id}/status/{cloud_account_id}/{action_name} Enable or Disable Cloud Account

📘

Return Type

  • Deletemessage//Response message
  • POST/governance/guardrails/policies/{tenant_id}/create Create Policy Schedules

📘

Return Type

  • Deletestatus//Status of the Create Schedule Call
  • Deletemessage//Message of the Create Schedule Call
  • Change schedule_id
  • DELETE/governance/guardrails/policies/{tenant_id}/delete/{schedule_id} Delete Policy Schedules

📘

Return Type

  • Deletestatus//Status of the Delete Schedule Call
  • Deletemessage//Message of the Delete Schedule Call
  • PUT/governance/guardrails/policies/{tenant_id}/update/{schedule_id} Update Policy Schedules

📘

Return Type

  • Deletestatus//Status of the Update Schedule Call
  • Deletemessage//Message of the Update Schedule Call
  • POST/governance/guardrails/{tenant_id}/policies Create Policy

📘

Parameter

  • Change CreatePolicyRequest.engine_type (Removed Enum)
  • Change CreatePolicyRequest.cloud
  • Change CreatePolicyRequest.scope
  • Change CreatePolicyRequest.content_type
  • GET/governance/guardrails/{tenant_id}/policies List Policies

📘

Parameter

  • Change engine_type
  • POST/governance/guardrails/{tenant_id}/policies/batch Batch Policies

📘

Return Type

  • Add policy_id//Policy Id is unique identifier of a policy
  • Add recommendation_actions//Recommendation actions of the policy
  • Deleteparameters.name//Name of the parameter
  • Deleteparameters.is_required//Whether the parameter is required.
  • Deleteparameters.schema
  • Change services
  • Change engine_type (Removed Enum)
  • Change recommendation_description
  • DELETE/governance/guardrails/{tenant_id}/policies/{policy_id} Delete Policy

📘

Return Type

  • Deletemessage//Delete Response message.
  • PUT/governance/guardrails/{tenant_id}/policies/{policy_id} Update Policy

📘

Parameter

  • Add UpdatePolicyRequest

  • DeleteUpdatePolicyRequestModel

📘

Return Type

  • Deletemessage//Response Message on update
  • GET/governance/guardrails/{tenant_id}/policies/{policy_id} Describe Policy

📘

Return Type

  • Change scope
  • POST/governance/guardrails/{tenant_id}/policies/{policy_id}/execute Execute Policy

📘

Parameter

  • Add PolicyExecuteRequest
  • DeletePolicyExecuteRequestModel
  • GET/governance/guardrails/{tenant_id}/recommendations List Policy Recommendations

📘

Return Type

  • Deleterecommendations.recommendation_id//unique recommendation Id
  • Deleterecommendations.recommendation_name//recommendation name
  • Deleterecommendations.policy_id//list of policy ids for which the recommendation exists
  • Deleterecommendations.status//resolution status of the recommendation the values will be open, resolved
  • Deleterecommendations.impact//impact of recommended changes
  • Deleterecommendations.classification//classified based on the kind of recommendation provided to the user can be cost, security etc
  • Deleterecommendations.cloud_account_id//cloud account id impacted by the recommendation
  • Deleterecommendations.cloud//cloud on which this account exits for which the recommendations exists
  • Deleterecommendations.tenant_name//tenant for which the recommendation exits
  • Deleterecommendations.created_at//UTC time at which the recommendation was created
  • POST/governance/guardrails/{tenant_id}/recommendations/{recommendation_id} Execute Policy Recommendation

📘

Parameter

  • Add ExecuteRecommendationRequest

  • DeleteExecuteRecommendationRequestModel

📘

Return Type

  • Deletemessage//Execute policy response message