Guides

External APIs 5.0 (2501)

April 2025

Suggest Edits
Changelog

Changelog

What's New⇑

  1. POST/cost_anomaly/reject_anomaly Reject Billing Cost Anomaly
  2. POST/v1/ai_agent/chat/create Returns created chat id and chat name
  3. PUT/v1/ai_agent/chat/item/{chat_id} Updates Chat Name
  4. POST/v1/ai_agent/chat/item/{chat_id} Chat History
  5. DELETE/v1/ai_agent/chat/item/{chat_id} Deletes Chat
  6. POST/v1/ai_agent/chat/item/{chat_id}/converse Returns the conversation
  7. POST/v1/ai_agent/chat/list Returns List of created chats id with chat name and conversation length
  8. POST/v1/ai_agent/template Returns the sample questions
  9. GET/v1/ai_agent/{tenant_id}/list List the agents available
  10. POST/v1/billing/commitment Get billing commitment details
  11. POST/v1/billing/commitment/events List all billing commitment events
  12. POST/v1/billing_plans/batch Fetch all Billing Plan definitions
  13. POST/v1/billing_plans/create Create a new Billing Plan definition
  14. POST/v1/billing_plans/list Fetch all Billing Plan definitions for the user
  15. POST/v1/billing_plans/version/batch Fetch Billing Plan versions by ids
  16. POST/v1/billing_plans/version/create Create a new version of a Billing Plan
  17. POST/v1/billing_plans/version/parse_import Parse Billing Plan Version
  18. GET/v1/billing_plans/version/{version_id} Get Billing Plan version details by version_id
  19. PATCH/v1/billing_plans/version/{version_id}/make_head Make a Billing Plan version the head version
  20. PATCH/v1/billing_plans/version/{version_id}/make_release Make a Billing Plan version the release version
  21. GET/v1/billing_plans/{plan_definition_id} Get Billing Plan definition by id
  22. DELETE/v1/billing_plans/{plan_definition_id} Delete Billing Plan by plan_id
  23. GET/v1/billing_plans/{plan_definition_id}/history Get Billing Plan definition history by definition id
  24. POST/v1/billing_plans/{plan_definition_id}/set_state Set the state of a Billing Plan definition
  25. POST/v1/currency_exchange_configuration/batch Batch Currency Exchange Configuration
  26. POST/v1/currency_exchange_configuration/create Create Currency Exchange Configuration
  27. GET/v1/currency_exchange_configuration/item/{item_id} Get Currency Exchange Configuration
  28. POST/v1/currency_exchange_configuration/item/{item_id} Update Currency Exchange Configuration
  29. DELETE/v1/currency_exchange_configuration/item/{item_id} Delete Currency Exchange Configuration
  30. POST/v1/currency_exchange_configuration/list List Currency Exchange Configuration
  31. POST/v1/executive_dashboard/report/generate Schedule the generation of a report for a dashboard
  32. GET/v1/executive_dashboard/report/item/{report_id} Fetch a report by ID
  33. POST/v1/master_data/categories/list List Master data
  34. POST/v1/operations/utilization_data/aggregate Batch Utilization Data
  35. POST/v1/operations/utilization_data/statistics List KPI statistics for Utilization Dashboard
  36. POST/v1/recommendations/batch Get the List of Recommendation Details
  37. POST/v1/recommendations/exclusion_rule/apply Apply all the Recommendation Exclusion Rules which are available/applicable/provided in the tenant
  38. POST/v1/recommendations/exclusion_rule/batch Fetch a Recommendation Exclusion Rule Details
  39. POST/v1/recommendations/exclusion_rule/create Creates a Recommendation Exclusion Rule
  40. GET/v1/recommendations/exclusion_rule/item/{rule_id} Get Recommendation Exclusion Rule
  41. POST/v1/recommendations/exclusion_rule/item/{rule_id} Update Recommendation Exclusion Rule
  42. DELETE/v1/recommendations/exclusion_rule/item/{rule_id} Delete Recommendation Exclusion Rule
  43. POST/v1/recommendations/exclusion_rule/list List of Recommendation Exclusion Rules
  44. POST/v1/recommendations/list List of Recommendations
  45. POST/v1/recommendations/resources/batch List of Resource Recommendation Details
  46. POST/v1/recommendations/resources/list Fetch a List of Resource Recommendation
  47. POST/v1/resource/log_analytics/list_workspaces List of Log Analytics Workspaces at Tenant Level
  48. POST/v2/billing/aggregation Aggregate costs based on input criteria
  49. POST/v2/billing/aggregation/batch Aggregate costs based on input criteria
  50. POST/v2/billing/aggregation/trend Aggregate costs in a trend based on input criteria
  51. POST/v2/billing/extras List extra keys used in service accounts
  52. POST/v2/billing/line_items_summary List values for group_by key used in service accounts
  53. POST/v2/billing/rate/aggregation/trend Aggregate rate in a trend based on input criteria
  54. POST/v2/billing/tags List tag keys used in service accounts
  55. POST/v2/billing/usage/aggregation/trend Aggregate usage in a trend based on input criteria
  56. POST/v2/billing_info/batch Fetch Billing Information
  57. POST/v2/billing_metrics/batch Batch of Billing Metrics
  58. POST/v2/billing_metrics/create Create new Billing Metrics
  59. POST/v2/billing_metrics/item/{billing_metrics_id} Update Billing Metrics
  60. DELETE/v2/billing_metrics/item/{billing_metrics_id} Delete Billing Metrics
  61. GET/v2/billing_metrics/list List Billing Metrics
  62. POST/v1/workload-query/resource/filters/service-resource Returns list of WorkloadServiceResource with all possible filter values for the given cloud accounts

What's Decommissioned⇑

  1. POST/cost/executive_dashboard/cloud_forecaster_for_six_months Get cloud Forecaster for six months
  2. POST/cost/executive_dashboard/spend-by-billing-type Get Cost Spend By Billing Type
  3. POST/cost/executive_dashboard/spend-by-cloud Get Cost Spend By Cloud
  4. POST/cost/executive_dashboard/spend-by-cloud-account Get Cost Spend By Cloud Account
  5. POST/cost/executive_dashboard/spend_by_cloud_resource_category Get Cost Spend By Cloud and Resource Category
  6. POST/cost/executive_dashboard/spend_by_cloud_tenant Get Cost Spend By Cloud and Tenant
  7. POST/cost/executive_dashboard/spend_by_region Get Cost Spend By Region
  8. POST/cost/executive_dashboard/spend_by_tagged_untagged Get Tag And Untag Cloudwise Trend
  9. POST/cost/executive_dashboard/spend_trend_by_cloud Get Cost Trend By Cloud
  10. POST/cost/executive_dashboard/spend_trend_by_cloud_resource_category Get Cost Spend Trend By Product Category
  11. POST/cost/executive_dashboard/tagged_and_untagged_spend_by_cloud Get Tagged and Untagged Spend Cloud Wise
  12. POST/cost/trend_analysis/tag CostTag Report
  13. POST/cost/trend_analysis/trend Cost Trend Report
  14. POST/v1/cost/estimated_cost Returns a forecast monthly costs for service accounts
  15. POST/v1/cost/resource_wise_billing_monthly/aggregate Returns a resource wise monthly bill for given service account and sku list
  16. POST/v1/cost/resource_wise_billing_monthly/latest Returns the latest resource wise monthly bill for given service account and resource id
  17. GET/v1/workload-query/resource/filters/service-resource Returns list of WorkloadServiceResource with all possible filter values

What's Changed⇑

  1. POST/cost/executive_dashboard/cost_optimization_by_optimization_types cost optimization by optimization type

    • Parameter

      • Add CostOptimizationByOptimizationTypesRequest.deduplication//Deduplication of the data
      • Add CostOptimizationByOptimizationTypesRequest.filter.category//Inventory Category of the resources to filter (all if missing)
      • Add CostOptimizationByOptimizationTypesRequest.filter.resource_type//Type of Resources to include (all if missing)
  2. POST/cost/executive_dashboard/cost_optimization_trend Get cost optimization trend

    • Parameter

      • Add CostOptimizationTrendRequest.filter.category//Inventory Category of the resources to filter (all if missing)
      • Add CostOptimizationTrendRequest.filter.resource_type//Type of Resources to include (all if missing)
  3. GET/cost/markups_and_discounts/{tenant_id}/list List Cost Markup Rules

    • Return Type

      • Change rule_type (Added Enum)
  4. POST/cost_anomaly/billing_cost_anomaly Get Account wise daily Billing Cost Anomaly

    • Parameter

      • Add CostAnomalySummaryRequest.service_account_ids//Service Account IDs
      • Add CostAnomalySummaryRequest.filters//Query expression to filter line items
      • Add CostAnomalySummaryRequest.anomaly_status//Required Anomaly status
      • DeleteCostAnomalySummaryRequest.filter
      • DeleteCostAnomalySummaryRequest.currency//currency of the cost. Example 'currency':'USD'

    • Return Type

      • Add details.categories//categories wise daily cost anomaly summary
      • Add details.service_account_level_anomalies.reject_until//Rejected Until time for the anomaly
      • Add details.service_account_level_anomalies.reject_reason//Rejected Reason
      • Deletedetails.product_categories//Product category wise daily cost anomaly summary
      • Change details.bill_date
  5. POST/governance/guardrails/{tenant_id}/policies/list List Policies

    • Parameter

      • Change PolicyListRequest.classification (Added Enum)

    • Return Type

      • Change policies.classification (Added Enum)
  6. GET/tenants List Tenant

    • Return Type

      • Add tenants.fiscal_year_configuration//Fiscal Year settings
      • Add tenants.cost_anomaly_settings
      • Add tenants.azure_hybrid_benefits_enabled//azure hybrid benefits enabled under finOps
      • Add tenants.disk_utilization_settings//enables disk utilization configuration for specified service accounts
  7. PUT/tenants/{tenant_id} Update Tenant

    • Parameter

      • Add UpdateTenantRequest.fiscal_year_configuration//Fiscal Year settings
      • Add UpdateTenantRequest.cost_anomaly_settings
      • Add UpdateTenantRequest.azure_hybrid_benefits_enabled//azure hybrid benefits enabled under finOps
      • Add UpdateTenantRequest.disk_utilization_settings//enables disk utilization configuration for specified service accounts
  8. GET/users/filter-options List Users

    • Return Type

      • Add tenants.tags//List of tag key/value pairs
      • Add tenants.cloud_providers.cloud_accounts.tags//List of tag key/value pairs
      • Deleteproduct_categories
      • Deleteregions
  9. POST/v1/aws-security-hub/dashboard/findings/list Returns a list AWS Security Hub Findings ids

    • Parameter

      • Add AwsSecurityHubFindingListRequest.filters.filters.category//Inventory Category of the resources to filter (all if missing)
      • Add AwsSecurityHubFindingListRequest.filters.filters.resource_type//Type of Resources to include (all if missing)
  10. POST/v1/cost/tags/list Returns a list of CostTag ids

    • Parameter

      • Add CostTagListRequest.filters.category//Inventory Category of the resources to filter (all if missing)
      • Add CostTagListRequest.filters.resource_type//Type of Resources to include (all if missing)
  11. POST/v1/executive_dashboard_version/parseImport Parse Dashboard Definition Version

    • Return Type

      • Add flavor//Flavor of the dashboard
      • Add cloud//Cloud provider for the dashboard. If not specified, the dashboard is considered multi-cloud.
      • Add filterScope//Scope for the data available in the dashboard
      • Add savedViews
  12. GET/v1/feature_requirements/list List Feature requirements

    • Return Type

      • Change feature (Added Enum)
      • Change providers.mandatory_dependent_features
      • Change providers.optional_dependent_features
      • Change providers.ondemand_dependent_features
  13. POST/v1/master_accounts

    • Parameter

      • Add CreateMasterAccountRequest.fiscal_year_configuration//Fiscal Year settings
  14. GET/v1/master_accounts/item/{master_account_id} Master Account View

    • Return Type

      • Add fiscal_year_configuration//Fiscal Year settings
      • Add cost_anomaly_settings
  15. PUT/v1/master_accounts/item/{master_account_id} Master Account Update

    • Parameter

      • Add MasterAccountDetails.fiscal_year_configuration//Fiscal Year settings
      • Add MasterAccountDetails.cost_anomaly_settings

    • Return Type

      • Add fiscal_year_configuration//Fiscal Year settings
      • Add cost_anomaly_settings
  16. GET/v1/products/list List Products

    • Return Type

      • Change features
  17. POST/v1/resource/virtual_machine_agents/list List VM Agents Details

    • Parameter

      • Add VirtualMachineAgentsListRequest.filters.cloud//Cloud Provider to select
      • Change VirtualMachineAgentsListRequest.filters.agents
  18. GET/v1/role_templates/list List Role Templates

    • Return Type

      • Change policies.policy (Added Enum)
  19. POST/v1/schedules/list List Schedules of given category

    • Parameter

      • Change ScheduleListRequest.sort.column (Added Enum)
  20. POST/v1/tag_baselines/available_tags/list Returns a list of AvailableTags ids

    • Parameter

      • Add TagBaselineAvailableTagListRequest.filters.filters.category//Inventory Category of the resources to filter (all if missing)
      • Add TagBaselineAvailableTagListRequest.filters.filters.resource_type//Type of Resources to include (all if missing)
  21. POST/v1/tag_posture/snapshot/item/{snapshot_id}/resource_summary Summarize the tag posture matching the filtering criteria returning resource coverage counts

    • Parameter

      • Add TagPostureSummaryListRequest.filters.filter.category//Inventory Category of the resources to filter (all if missing)
      • Add TagPostureSummaryListRequest.filters.filter.resource_type//Type of Resources to include (all if missing)

    • Return Type

      • Add missing_tag_keys//List of missing tag keys
      • Add invalid_tag_values//Map of invalid tag values
  22. POST/v1/tag_posture/snapshot/item/{snapshot_id}/summary/cloud_account/list Returns a list of TagPostureCloudAccountSummary identifiers based on input filters

    • Parameter

      • Add TagPostureSummaryListRequest.filters.filter.category//Inventory Category of the resources to filter (all if missing)
      • Add TagPostureSummaryListRequest.filters.filter.resource_type//Type of Resources to include (all if missing)
  23. POST/v1/tag_posture/snapshot/item/{snapshot_id}/summary/resource/list Returns a list of TagPostureResourceSummary identifiers based on input filters

    • Parameter

      • Add TagPostureSummaryListRequest.filters.filter.category//Inventory Category of the resources to filter (all if missing)
      • Add TagPostureSummaryListRequest.filters.filter.resource_type//Type of Resources to include (all if missing)
  24. POST/v1/tag_posture/snapshot/item/{snapshot_id}/workload_summary/{workload_id}/resource/list Returns a batch of TagPostureWorkloadResourceSummary

    • Parameter

      • Add TagPostureSummaryListRequest.filters.filter.category//Inventory Category of the resources to filter (all if missing)
      • Add TagPostureSummaryListRequest.filters.filter.resource_type//Type of Resources to include (all if missing)
  25. POST/v1/well-architected-framework/assessment-run/batch Get a batch of assessment run details

    • Return Type

      • Add assessment_definition//The Assessment this run is for
  26. POST/v1/well-architected-framework/assessment-run/create Start an assessment run for the assessment definition

    • Return Type

      • Add assessment_definition//The Assessment this run is for
  27. GET/v1/well-architected-framework/assessment-run/item/{assessment_run_id} Fetch the details for an assessment run by ID

    • Return Type

      • Add assessment_definition//The Assessment this run is for
  28. POST/v1/well-architected-framework/assessment-run/item/{assessment_run_id}/set-state Set the state for an assessment run

    • Return Type

      • Add assessment_definition//The Assessment this run is for
  29. POST/v2/audit/auditlog/list Audit List

    • Parameter

      • Change AuditLogListRequest.filters.event_types
      • Change AuditLogListRequest.filters.event_actions
  30. POST/v2/service_account/create Create a new Service Account

    • Parameter

      • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)
  31. GET/v2/service_account/item/{service_account_id} Get Service Account details

    • Return Type

      • Change onboarded_features.feature (Added Enum)
  32. POST/v2/service_account/item/{service_account_id} Update Service Account details

    • Parameter

      • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)

    • Return Type

      • Change onboarded_features.feature (Added Enum)
  33. GET/v2/service_account/item/{service_account_id}/credentials_validation Validate Service Account Credentials

    • Return Type

      • Change onboarded_features.feature (Added Enum)
  34. POST/v2/service_account/item/{service_account_id}/dry_run Validate update of Service Account details

    • Parameter

      • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)

    • Return Type

      • Change onboarded_features.feature (Added Enum)
  35. POST/v2/service_account/item/{service_account_id}/extended_dry_run Validate update of Service Account details and check if the Governance Configuration can be accepted by the Cloud/Tool provider

    • Parameter

      • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)

    • Return Type

      • Change onboarded_features.feature (Added Enum)
  36. GET/v2/service_account/item/{service_account_id}/sync_status Get Current Sync Status

    • Return Type

      • Add finops__enterprise_discount_program//Enterprise Discount Program current status
      • Add metric_utilization_data//Utilization Dashboard Metric Sync current status
  37. POST/v2/service_account/item/{service_account_id}/sync_status Trigger refresh of Sync Status

    • Parameter

      • Add ServiceAccountSync.finops__enterprise_discount_program//Enterprise Discount Program current status
      • Add ServiceAccountSync.metric_utilization_data//Utilization Dashboard Metric Sync current status

    • Return Type

      • Add finops__enterprise_discount_program//Enterprise Discount Program current status
      • Add metric_utilization_data//Utilization Dashboard Metric Sync current status
  38. GET/v2/service_account/item/{service_account_id}/sync_status_history Get Sync Status History

    • Return Type

      • Add finops__enterprise_discount_program//Enterprise Discount Program status history
      • Add metric_utilization_data//Utilization Dashboard Metric Sync status history
  39. POST/v2/service_account/list List Service Accounts

    • Parameter

      • Add ServiceAccountListRequest.filters.sync_status.finops__enterprise_discount_program//Enterprise Discount Program current status
      • Add ServiceAccountListRequest.filters.sync_status.metric_utilization_data//Utilization Dashboard Metric Sync current status
      • Change ServiceAccountListRequest.filters.onboarded_any
      • Change ServiceAccountListRequest.filters.onboarded_all
  40. POST/v2/service_account/summary Summarize Service Accounts

    • Parameter

      • Add ServiceAccountSummaryRequest.filters.sync_status.finops__enterprise_discount_program//Enterprise Discount Program current status
      • Add ServiceAccountSummaryRequest.filters.sync_status.metric_utilization_data//Utilization Dashboard Metric Sync current status
      • Change ServiceAccountSummaryRequest.filters.onboarded_any
      • Change ServiceAccountSummaryRequest.filters.onboarded_all
  41. POST/v2/user_groups/list User Group List

    • Parameter

      • Add UserGroupListRequest.filters//Filters for the request

Updated 3 days ago