Guides

External APIs 4.4 (2402)

Released - October 2024

Suggest Edits

Changelog

What's New

  • POST/cost/executive_dashboard/spend_by_tagged_untagged Get Tag And Untag Cloudwise Trend
  • POST/cost/executive_dashboard/spend_trend_by_cloud Get Cost Trend By Cloud
  • POST/cost/executive_dashboard/spend_trend_by_cloud_resource_category Get Cost Spend Trend By Product Category
  • GET/v1/cost/finops_assessment_trigger_history/{cloud_account_id} Finops Assessment Trigger History
  • GET/v1/cost/finops_assessment_trigger_status/{assessment_run_id} Finops Assessment Trigger Status
  • GET/v1/integrations/servicenow/{service_account_id}/incident/custom_reference_attributes List ServiceNow Incident Custom Attributes
  • POST/v1/integrations/servicenow/{service_account_id}/table/{table_name}/rows List ServiceNow Table Rows
  • GET/v1/resource/inventory/item/{corestack_resource_id} Get ServiceResourceInventory Details
  • POST/v1/resource/inventory/lookup Lookup ServiceResourceInventory Service Accounts
  • GET/v1/runbook/{tenant_id}/AWS/execution/filters/{document_type} List execution filters
  • POST/v1/well-architected-framework/assessment/report/generate Schedule the generation of a report for an assessment run
  • GET/v1/well-architected-framework/assessment/report/item/{report_id} Fetch an assessment run report by ID
  • POST/v2/service_account/summary Summarize Service Accounts
  • POST/recommendations/{tenant_id}/account/list List Recommendations by Account
  • PUT/v1/master_accounts/item/{master_account_id} Master Account Update

What's Decommissioned

  • POST/cost/executive_dashboard/cost_trend_by_cloud Get Cost Trend By Cloud
  • POST/cost/executive_dashboard/tagged_untagged_trend_cost_trend Get Tag And Untag Cloudwise Trend
  • POST/cost_anomaly/rule_based_cost_anomaly Get Account wise daily Rule Cost Anomaly
  • GET/governance/account/{tenant_id}/{category}/get/{cloud_account_id}/governance_configuration Governance Configuration
  • POST/v1/resource/service_resource_inventory Get ServiceResourceInventory Details
  • GET/v1/runbook/{tenant_id}/AWS/execution/filters List execution filters
  • POST/v1/well-architected-framework/assessment-run-report/create Schedule the generation of a report for an assessment run
  • POST/v1/well-architected-framework/assessment-run-report/item/{report_id} Fetch an assessment run report by ID
  • GET/recommendations/{tenant_id}/account/list List Recommendations by Account

What's Changed

  • POST/budget/create Create Budget

    📘

    Parameter

    • Change BudgetCreateUpdateRequest.budget_details.currency (Added Enum)
  • POST/budget/dashboard/budget_alert_exceeds_count View Count Budget Alert Exceeds Summary

    📘

    Parameter

    • Change BudgetSummaryRequest.filter_params.currency (Added Enum)
  • POST/budget/dashboard/budget_summary_count View Count Budget Summary

    📘

    Parameter

    • Change BudgetSummaryRequest.filter_params.currency (Added Enum)
  • POST/budget/dashboard/list_budgets View Budget Dashboard

    📘

    Parameter

    • Change BudgetListRequest.currency (Added Enum)
  • PUT/budget/update Update Budget

    📘

    Parameter

    • Change BudgetCreateUpdateRequest.budget_details.currency (Added Enum)
  • GET/budget/{tenant_id}/{budget_id}/view List Budget Detail

    📘

    Return Type

    • Change summary.budget_details.currency (Added Enum)
  • GET/cost/cost_savings/cost_saved_recommendation List Cost Saving Recommendations

    📘

    Parameter

    • Change currency
  • PUT/cost/cost_savings/tenants/visibility/{tenant_id} List Cost Saving Recommendation by Tenant

    📘

    Parameter

    • Change ListRecommendationsTenantRequest.currency (Added Enum)
  • POST/cost/costoptimizer/optimizerate/license_benefit/hub_discounts License Benefit Hub Discounts

    📘

    Parameter

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

    📘

    Parameter

    • Change LicenseBenefitSavingRequest.currency (Added Enum)
  • GET/cost/costoptimizer/optimizeusage/{tenant_id}/cloud_accounts View Cloud Account_ID and Cloud Account Name

    📘

    Parameter

    • Change currency
  • GET/cost/costoptimizer/optimizeusage/{tenant_id}/summary Tenant Wise Cost Summary

    📘

    Parameter

    • Change currency
  • POST/cost/executive_dashboard/cloud_forecaster_for_six_months Get cloud Forecaster for six months

    📘

    Parameter

    • Change CloudForecasterForSixMonthsRequest.currency (Added Enum)

    Return Type

    • Add start_date//specify the start date. start_date: yyyy-mm-dd

    • Add end_date//specify the start date. start_date: yyyy-mm-dd

    • Deletedate//specify the start date. start_date: yyyy-mm-dd

  • POST/cost/executive_dashboard/cost_optimization_by_optimization_types cost optimization by optimization type

    📘

    Parameter

    • Change CostOptimizationByOptimizationTypesRequest.currency (Added Enum)

    Return Type

    • Add resource_id//resource_id
  • POST/cost/executive_dashboard/cost_optimization_trend Get cost optimization trend

    📘

    Parameter

    • Change CostOptimizationTrendRequest.currency (Added Enum)
  • GET/cost/markups_and_discounts/{tenant_id}/list List Cost Markup Rules

    📘

    Return Type

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

    📘

    Parameter

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

    📘

    Parameter

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

    📘

    Parameter

    • Change CostSummaryRequest.filter.account_type
    • Change CostSummaryRequest.filter.cloud_service
  • POST/cost/posture/dashboard_summary List Dashboard Summary by Account, Tenant, Service type

    📘

    Parameter

    • Change CostDashboardSummaryRequest.currency (Added Enum)

    Return Type

    • Change available_currency (Added Enum)

    • Change selected_currency (Added Enum)

    • Change account_usage.currency (Added Enum)

    • Change tenant_usage.currency (Added Enum)

  • PUT/cost/posture/ea_view_or_csp_view List Dashboard by Identifier

    📘

    Parameter

    • Change CostSummaryEAOrCSPRequest.currency (Added Enum)
    • Change CostSummaryEAOrCSPRequest.filter.account_type
    • Change CostSummaryEAOrCSPRequest.filter.cloud_service
  • PUT/cost/posture/ea_view_or_csp_view/visibility List Dashboard by EA or CSP View For Visibility

    📘

    Parameter

    • Change CostSummaryEAOrCSPVisibilityRequest.currency (Added Enum)
  • PUT/cost/posture/service_type List Dashboard Summary by Cloud

    📘

    Parameter

    • Change CostSummaryDataReqServiceType.currency (Added Enum)
  • PUT/cost/posture/tenants List Dashboard Summary by Tenant

    📘

    Parameter

    • Change CostSummaryReqModelTenant.filter.account_type
    • Change CostSummaryReqModelTenant.filter.cloud_service
  • GET/cost/posture/{tenant_id}/get_cost_hierarchy Get Cost Hierarchy

    📘

    Parameter

    • Change currency
  • POST/cost/ri/recommendation List Recommendations

    📘

    Parameter

    • Change ListRIRecommendationsRequest.currency (Added Enum)
  • GET/cost/ri/utilization/reservations List Cost Reservations & Utilization

    📘

    Parameter

    • Change currency
  • POST/cost_anomaly/billing_cost_anomaly Get Account wise daily Billing Cost Anomaly

    📘

    Parameter

    • Change CostAnomalySummaryRequest.currency (Added Enum)
  • POST/governance/guardrails/{tenant_id}/policies/batch Batch Policies

    📘

    Return Type

    • Add display_name//Display name of the policy
    • Add resource_category//Category of resource
    • Add resource_type//Type of resource
    • Add service_resources//Service resources of policy
    • Add equivalent_policies//Equivalent policy names
    • Change name
  • POST/recommendations/{definition_id}/resolve_preexecute Resolve Recommendation Action Preexecute

    📘

    Parameter

    • Deleteaction//Specify the action to fetch data
  • POST/recommendations/{tenant_id}/resolve_preexecute/{recommendation_id} Resolve PreExecute Recommendation

    📘

    Parameter

    • Deleteaction//Specify the action to fetch data
  • POST/resource/inventory/{tenant_id}/resources Get Inventory Details

    📘

    Parameter

    • Add InventoryResourceDetailsRequest.filters.fetch_live_status//Specify to fetch the live ping status of the AWS SSM enabled instance.
  • GET/tenants List Tenant

    📘

    Return Type

    • Change tenants.status
  • PUT/tenants/{tenant_id} Update Tenant

    📘

    Parameter

    • Change UpdateTenantRequest.status
  • GET/users/filter-options List Users

    📘

    Return Type

    • Change tenants.cloud_providers.cloud_accounts.currency (Added Enum)
    • Change tenants.integrated_tool_providers.tool (Added Enum)
  • POST/v1/cost/costoptimizer/optimizerate/long_term_savings/recommended_reservations/savings_summary Saving Summary for Recommended Reservations

    📘

    Parameter

    • Change RecommendedReservationsSavingsSummaryRequest.currency (Added Enum)
  • POST/v1/cost/finops_assessment_trigger/{tenant_id}/{cloud_account_id} Finops Assessment Trigger

    📘

    Return Type

    • Add assessment_run_id//Assessment run id
    • Deletecloud_account_id//cloud account id
  • POST/v1/cost/resource_wise_billing_monthly/latest Returns the latest resource wise monthly bill for given service account and resource id

    📘

    Parameter

    • DeleteResourceWiseBillingMonthlyLatestRequest.billing_end_date//End Date of billing period

    Return Type

    • Add latest_resource_cost//Resource cost for the usage

    • Add billing_start_date//Start Date of billing period

    • Deleterate//Rate for the usage

  • GET/v1/feature_requirements/list List Feature requirements

    📘

    Return Type

    • Deleteproviders.access_policies.cloud//Cloud Provider to select
    • Change feature (Added Enum)
    • Change providers.mandatory_dependent_features
    • Change providers.optional_dependent_features
    • Change providers.ondemand_dependent_features
  • POST/v1/master_accounts

    📘

    Parameter

    • Add CreateMasterAccountRequest.sso_tenant_id//SSO tenant id
    • Add CreateMasterAccountRequest.mfa_enabled//Flag to enable MFA for the master account
    • Add CreateMasterAccountRequest.custom_tags//List of tag key/value pairs
    • Add CreateMasterAccountRequest.third_party_subscription_details//Third party subscription details
    • DeleteCreateMasterAccountRequest.subscription_info.action//Action will be create for project master creation
    • DeleteCreateMasterAccountRequest.subscription_info.subscription_id//Subscription id of user
    • DeleteCreateMasterAccountRequest.notification_settings.email_template//Email Template
    • DeleteCreateMasterAccountRequest.notification_settings.header_logo//Header Logo
    • DeleteCreateMasterAccountRequest.notification_settings.footer_text//Footer text
    • DeleteCreateMasterAccountRequest.notification_settings.template_type//Type of template
    • DeleteCreateMasterAccountRequest.notification_settings.email_settings//Email settings
  • GET/v1/master_accounts/item/{master_account_id} Master Account View

    📘

    Return Type

    • Add notification_settings//Notification settings
    • Add crm_id//CRM id
    • Add auth_config//Auth Configuration
    • Deletesegment//segment
    • Deleteindustry//industry
    • Deletecountry//country
    • Deletesize//size
    • Deleteregion//region
    • Deletesubscription_info.action//Action will be create for project master creation
    • Deletesubscription_info.subscription_id//Subscription id of user
  • GET/v1/master_accounts/{master_account_id}/tenants Tenant List by Master Account

    📘

    Return Type

    • Add status//Indicates the status of the Tenant
    • Add is_default//Is this a default tenant
  • GET/v1/products/list List Products

    📘

    Return Type

    • Change features
  • POST/v1/resource/smallest_sku_region Get unit price of smallest sku for a specific region

    📘

    Parameter

    • Change ResourceUnitPriceCheapestSkuRequest.currency (Added Enum)
  • GET/v1/role_templates/list List Role Templates

    📘

    Return Type

    • Change policies.policy (Added Enum)
    • Change integrated_tools
  • POST/v1/stacks-marketplace/products/batch Batch Stacks Marketplace Products

    📘

    Return Type

    • Add results//Map from identifier to response model
  • POST/v1/stacks-marketplace/stack-definition-versions/batch Batch Stacks Marketplace Stack Definition Versions

    📘

    Return Type

    • Add results//Map from identifier to response model
  • GET/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/publishing/{master_account_id}/history Get Stacks Marketplace Stack Definitions Version Publishing History

    📘

    Return Type

    • Add auto_publish_settings//Auto-Publish settings
  • POST/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/publishing/{master_account_id}/state Set State for Stacks Marketplace Stack Definition Version Publishing

    📘

    Parameter

    • Add StacksMarketplaceStackPublishingState.auto_publish_settings//Auto-Publish settings

    Return Type

    • Add auto_publish_settings//Auto-Publish settings
  • GET/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/publishing/{master_account_id}/state Get State for Stacks Marketplace Stack Definition Version Publishing

    📘

    Return Type

    • Add auto_publish_settings//Auto-Publish settings
  • POST/v1/stacks-marketplace/stack-definitions/batch Batch Stacks Marketplace Stack Definitions

    📘

    Return Type

    • Add results//Map from identifier to response model
  • GET/v1/stacks-marketplace/stack-definitions/item/{stack_definition_id}/history Get Stacks Marketplace Stack Definition History

    📘

    Return Type

    • Add results//Map from identifier to response model
  • POST/v1/stacks-marketplace/stack-deployment/batch Batch Stacks Marketplace Stack Deployments

    📘

    Return Type

    • Add results//Map from identifier to response model
  • POST/v1/stacks-marketplace/stack-deployment/history/batch Batch Stacks Marketplace Stack Deployment History

    📘

    Return Type

    • Add results//Map from identifier to response model
    • Deletedeployment_id//Deployment ID
    • Deletestack_version_id//Stack version ID
    • Deletestack_deployment_action//Deployment action of the resource
    • Deletejob_id//Job ID
    • Deleteinitiated_at//Initiated at
    • Deletecompleted_at//Completed at
    • Deletestatus//Deployment execution status
    • Deleteinitiated_by//Initiated by
    • Deletedistributor_id//Distributor ID
    • Deleteinput_parameters//JSON encoded string of input parameters
    • Deleterun_name//Run name
    • Deletestatus_message//Status message
  • GET/v1/user/switch_account/{master_account_id} Switch Master Account

    📘

    Return Type

    • Add user_guide_url//User Guide URL
    • Add support_url//Support URL
    • Add terms_and_conditions_url//Terms and Conditions URL
  • GET/v1/user_details Get User session and roles details

    📘

    Return Type

    • Add user_guide_url//User Guide URL
    • Add support_url//Support URL
    • Add terms_and_conditions_url//Terms and Conditions URL
  • POST/v1/workload-query/resource/batch Returns a list of ServiceResourceInventory

    📘

    Return Type

    • Add service_resource_id//Unique identifier of the resource
  • POST/v2/audit/auditlog/list Audit List

    📘

    Parameter

    • Change AuditLogListRequest.filters.event_types
    • Change AuditLogListRequest.filters.event_actions
  • POST/v2/schedule_recommendations/filters Schedule Recommendations Filters

    📘

    Return Type

    • Change currencies
  • POST/v2/schedule_recommendations/list_resource_schedule Schedule Recommendations Resource Schedule List

    📘

    Return Type

    • Change currency (Added Enum)
  • POST/v2/schedule_recommendations/list_schedules Schedule Recommendations Schedule List

    📘

    Parameter

    • Change ScheduleRecommendationScheduleRequest.currencies
  • POST/v2/schedule_recommendations/resource_details Schedule Recommendations Resource Details

    📘

    Return Type

    • Change currency (Added Enum)
  • POST/v2/schedule_recommendations/summary Schedule Recommendations Summary

    📘

    Parameter

    • Change ScheduleRecommendationSummaryRequest.currency (Added Enum)
  • POST/v2/service_account/create Create a new Service Account

    📘

    Parameter

    • Add ServiceAccountDetails.billing_account_id//Link to Service Account that is used to retrieve billing information.
    • Change ServiceAccountDetails.currency (Added Enum)
    • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)
  • POST/v2/service_account/item/{service_account_id} Update Service Account details

    📘

    Parameter

    • Add ServiceAccountDetails.billing_account_id//Link to Service Account that is used to retrieve billing information.

    • Change ServiceAccountDetails.currency (Added Enum)

    • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)

    Return Type

    • Add billing_account_id//Link to Service Account that is used to retrieve billing information.

    • Change currency (Added Enum)

    • Change onboarded_features.feature (Added Enum)

  • GET/v2/service_account/item/{service_account_id} Get Service Account details

    📘

    Return Type

    • Add billing_account_id//Link to Service Account that is used to retrieve billing information.
    • Change currency (Added Enum)
    • Change onboarded_features.feature (Added Enum)
  • GET/v2/service_account/item/{service_account_id}/credentials_validation Validate Service Account Credentials

    📘

    Return Type

    • Add billing_account_id//Link to Service Account that is used to retrieve billing information.
    • Change currency (Added Enum)
    • Change onboarded_features.feature (Added Enum)
  • POST/v2/service_account/item/{service_account_id}/dry_run Validate update of Service Account details

    📘

    Parameter

    • Add ServiceAccountDetails.billing_account_id//Link to Service Account that is used to retrieve billing information.

    • Change ServiceAccountDetails.currency (Added Enum)

    • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)

    Return Type

    • Add billing_account_id//Link to Service Account that is used to retrieve billing information.

    • Change currency (Added Enum)

    • Change onboarded_features.feature (Added Enum)

  • 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

    • Add ServiceAccountDetails.billing_account_id//Link to Service Account that is used to retrieve billing information.

    • Change ServiceAccountDetails.currency (Added Enum)

    • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)

    Return Type

    • Add billing_account_id//Link to Service Account that is used to retrieve billing information.

    • Change currency (Added Enum)

    • Change onboarded_features.feature (Added Enum)

  • POST/v2/service_account/item/{service_account_id}/sync_status Trigger refresh of Sync Status

    📘

    Parameter

    • Add ServiceAccountSync.finops**savings_plans//Savings Plans current status

    Return Type

    • Add finops**savings_plans//Savings Plans current status
  • GET/v2/service_account/item/{service_account_id}/sync_status Get Current Sync Status

    📘

    Return Type

    • Add finops__savings_plans//Savings Plans current status
  • GET/v2/service_account/item/{service_account_id}/sync_status_history Get Sync Status History

    📘

    Return Type

    • Add finops__savings_plans//Savings Plans status history
  • POST/v2/service_account/list List Service Accounts

    📘

    Parameter

    • Add ServiceAccountListRequest.filters.include_billing_as_parent//Also include billing accounts as parents.
    • Add ServiceAccountListRequest.filters.sync_status.finops__savings_plans//Savings Plans current status
    • Change ServiceAccountListRequest.filters.currencies
    • Change ServiceAccountListRequest.filters.onboarded_any
    • Change ServiceAccountListRequest.filters.onboarded_all

What’s Coming in Next Release (2403)

What's New

  • POST/cost/executive_dashboard/spend_by_tagged_untagged Get Tag And Untag Cloudwise Trend
  • POST/cost/executive_dashboard/spend_trend_by_cloud Get Cost Trend By Cloud
  • POST/cost/executive_dashboard/spend_trend_by_cloud_resource_category Get Cost Spend Trend By Product Category
  • GET/v1/cost/finops_assessment_trigger_history/{cloud_account_id} Finops Assessment Trigger History
  • GET/v1/cost/finops_assessment_trigger_status/{assessment_run_id} Finops Assessment Trigger Status
  • GET/v1/integrations/servicenow/{service_account_id}/incident/custom_reference_attributes List ServiceNow Incident Custom Attributes
  • POST/v1/integrations/servicenow/{service_account_id}/table/{table_name}/rows List ServiceNow Table Rows
  • GET/v1/policy/configuration/policy/{policy_id}/tenant/{tenant_id}/service_account_list List accounts for policy configuration
  • GET/v1/policy/configuration/{policy_id}/service_account/{service_account_id} Get Policy parameter configuration Account
  • POST/v1/policy/configuration/{policy_id}/service_account/{service_account_id} Update Policy parameter configuration Account
  • DELETE/v1/policy/configuration/{policy_id}/service_account/{service_account_id} Delete Policy parameter configuration Account
  • POST/v1/policy/configuration/{policy_id}/service_account_batch Get account policy configuration batch
  • GET/v1/policy/configuration/{policy_id}/tenant/{tenant_id} Get Policy parameter configuration tenant
  • POST/v1/policy/configuration/{policy_id}/tenant/{tenant_id} Update Policy parameter configuration Tenant
  • DELETE/v1/policy/configuration/{policy_id}/tenant/{tenant_id} Delete Policy parameter configuration Tenant
  • GET/v1/resource/inventory/item/{corestack_resource_id} Get ServiceResourceInventory Details
  • POST/v1/resource/inventory/lookup Lookup ServiceResourceInventory Service Accounts
  • POST/v1/resource/tags/bulk_remediation Create Bulk Resource Tag Remediation
  • POST/v1/resource/tags/bulk_remediation_status Return bulk Resource Tag Remediation Status
  • POST/v1/resource/tags/remediation/{tenant_id} Create Resource Tag Remediation
  • POST/v1/resource/virtual_machine_agents/batch Batch VM Agents Details
  • POST/v1/resource/virtual_machine_agents/list List VM Agents Details
  • GET/v1/runbook/{tenant_id}/AWS/execution/filters/{document_type} List execution filters
  • POST/v1/schedules/batch Fetch a batch of schedules
  • POST/v1/schedules/create Creates a Schedule
  • GET/v1/schedules/item/{schedule_id} Retrieve Schedule
  • POST/v1/schedules/item/{schedule_id} Updates a Schedule
  • DELETE/v1/schedules/item/{schedule_id} Delete Schedule
  • POST/v1/schedules/list List Schedules of given category
  • POST/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/cost-estimate Initiates the cost estimation of a deployment run that could happen on a service account
  • GET/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/cost-estimate/{background_job_id}/status Gets the cost estimation of a deployment run that could happen on a service account
  • POST/v1/tag_posture/snapshot/item/{snapshot_id}/resource/batch Returns a batch of TagPostureResources
  • POST/v1/well-architected-framework/assessment/report/generate Schedule the generation of a report for an assessment run
  • GET/v1/well-architected-framework/assessment/report/item/{report_id} Fetch an assessment run report by ID
  • POST/v2/service_account/summary Summarize Service Accounts
  • POST/recommendations/{tenant_id}/account/list List Recommendations by Account
  • PUT/v1/master_accounts/item/{master_account_id} Master Account Update

What's Decommissioned

  • POST/cost/executive_dashboard/cost_trend_by_cloud Get Cost Trend By Cloud
  • POST/cost/executive_dashboard/tagged_untagged_trend_cost_trend Get Tag And Untag Cloudwise Trend
  • POST/cost_anomaly/rule_based_cost_anomaly Get Account wise daily Rule Cost Anomaly
  • GET/governance/account/{tenant_id}/validate_summary Cloud Accounts Summary
  • GET/governance/account/{tenant_id}/{category}/get/{cloud_account_id}/governance_configuration Governance Configuration
  • POST/resource/tags/{tenant_id}/remediation Create Resource Tag Remediation
  • POST/resource/tags/{tenant_id}/remediation_status/{cloud} Get Resource Tag Remediation Status
  • POST/v1/resource/service_resource_inventory Get ServiceResourceInventory Details
  • GET/v1/runbook/{tenant_id}/AWS/execution/filters List execution filters
  • POST/v1/well-architected-framework/assessment-run-report/create Schedule the generation of a report for an assessment run
  • POST/v1/well-architected-framework/assessment-run-report/item/{report_id} Fetch an assessment run report by ID
  • POST/v1/well-architected-framework/{tenant_id}/policy-params/get Get execution parameters for policy mapped to WAF framework
  • POST/v1/well-architected-framework/{tenant_id}/policy-params/set Configure execution parameters for policy mapped to WAF framework
  • GET/recommendations/{tenant_id}/account/list List Recommendations by Account

What's Changed

  • POST/budget/create Create Budget

    📘

    Parameter

    • Change BudgetCreateUpdateRequest.budget_details.currency (Added Enum)
  • POST/budget/dashboard/budget_alert_exceeds_count View Count Budget Alert Exceeds Summary

    📘

    Parameter

    • Change BudgetSummaryRequest.filter_params.currency (Added Enum)
  • POST/budget/dashboard/budget_summary_count View Count Budget Summary

    📘

    Parameter

    • Change BudgetSummaryRequest.filter_params.currency (Added Enum)
  • POST/budget/dashboard/list_budgets View Budget Dashboard

    📘

    Parameter

    • Change BudgetListRequest.currency (Added Enum)
  • PUT/budget/update Update Budget

    📘

    Parameter

    • Change BudgetCreateUpdateRequest.budget_details.currency (Added Enum)
  • GET/budget/{tenant_id}/{budget_id}/view List Budget Detail

    📘

    Return Type

    • Change summary.budget_details.currency (Added Enum)
  • GET/cost/cost_savings/cost_saved_recommendation List Cost Saving Recommendations

    📘

    Parameter

    • Change currency
  • PUT/cost/cost_savings/tenants/visibility/{tenant_id} List Cost Saving Recommendation by Tenant

    📘

    Parameter

    • Change ListRecommendationsTenantRequest.currency (Added Enum)
  • POST/cost/costoptimizer/optimizerate/license_benefit/hub_discounts License Benefit Hub Discounts

    📘

    Parameter

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

    📘

    Parameter

    • Change LicenseBenefitSavingRequest.currency (Added Enum)
  • GET/cost/costoptimizer/optimizeusage/{tenant_id}/cloud_accounts View Cloud Account_ID and Cloud Account Name

    📘

    Parameter

    • Change currency
  • GET/cost/costoptimizer/optimizeusage/{tenant_id}/summary Tenant Wise Cost Summary

    📘

    Parameter

    • Change currency
  • POST/cost/executive_dashboard/cloud_forecaster_for_six_months Get cloud Forecaster for six months

    📘

    Parameter

    • Change CloudForecasterForSixMonthsRequest.currency (Added Enum)

    Return Type

    • Add start_date//specify the start date. start_date: yyyy-mm-dd

    • Add end_date//specify the start date. start_date: yyyy-mm-dd

    • Deletedate//specify the start date. start_date: yyyy-mm-dd

  • POST/cost/executive_dashboard/cost_optimization_by_optimization_types cost optimization by optimization type

    📘

    Parameter

    • Change CostOptimizationByOptimizationTypesRequest.currency (Added Enum)

    Return Type

    • Add resource_id//resource_id
  • POST/cost/executive_dashboard/cost_optimization_trend Get cost optimization trend

    📘

    Parameter

    • Change CostOptimizationTrendRequest.currency (Added Enum)
  • GET/cost/markups_and_discounts/{tenant_id}/list List Cost Markup Rules

    📘

    Return Type

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

    📘

    Parameter

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

    📘

    Parameter

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

    📘

    Parameter

    • Change CostSummaryRequest.filter.account_type
    • Change CostSummaryRequest.filter.cloud_service
  • POST/cost/posture/dashboard_summary List Dashboard Summary by Account, Tenant, Service type

    📘

    Parameter

    • Change CostDashboardSummaryRequest.currency (Added Enum)

    Return Type

    • Change available_currency (Added Enum)

    • Change selected_currency (Added Enum)

    • Change account_usage.currency (Added Enum)

    • Change tenant_usage.currency (Added Enum)

  • PUT/cost/posture/ea_view_or_csp_view List Dashboard by Identifier

    📘

    Parameter

    • Change CostSummaryEAOrCSPRequest.currency (Added Enum)
    • Change CostSummaryEAOrCSPRequest.filter.account_type
    • Change CostSummaryEAOrCSPRequest.filter.cloud_service
  • PUT/cost/posture/ea_view_or_csp_view/visibility List Dashboard by EA or CSP View For Visibility

    📘

    Parameter

    • Change CostSummaryEAOrCSPVisibilityRequest.currency (Added Enum)
  • PUT/cost/posture/service_type List Dashboard Summary by Cloud

    📘

    Parameter

    • Change CostSummaryDataReqServiceType.currency (Added Enum)
  • PUT/cost/posture/tenants List Dashboard Summary by Tenant

    📘

    Parameter

    • Change CostSummaryReqModelTenant.filter.account_type
    • Change CostSummaryReqModelTenant.filter.cloud_service
  • GET/cost/posture/{tenant_id}/get_cost_hierarchy Get Cost Hierarchy

    📘

    Parameter

    • Change currency
  • POST/cost/ri/recommendation List Recommendations

    📘

    Parameter

    • Change ListRIRecommendationsRequest.currency (Added Enum)
  • GET/cost/ri/utilization/reservations List Cost Reservations & Utilization

    📘

    Parameter

    • Change currency
  • POST/cost_anomaly/billing_cost_anomaly Get Account wise daily Billing Cost Anomaly

    📘

    Parameter

    • Change CostAnomalySummaryRequest.currency (Added Enum)
  • POST/governance/guardrails/{tenant_id}/policies/batch Batch Policies

    📘

    Return Type

    • Add display_name//Display name of the policy
    • Add resource_category//Category of resource
    • Add resource_type//Type of resource
    • Add service_resources//Service resources of policy
    • Add equivalent_policies//Equivalent policy names
    • Change name
  • POST/operation/automation/scripts/{tenant_id} Create Script

    📘

    Parameter

    • Change CreateScriptRequest.platform
  • GET/operation/automation/scripts/{tenant_id} List Scripts

    📘

    Return Type

    • Change scripts.platform
  • POST/operation/automation/scripts/{tenant_id}/execute Execute Script

    📘

    Parameter

    • Add ExecuteScriptRequest.job_details//Execution input such as script/host details
    • DeleteExecuteScriptRequest.host_details//Execution input such as script/host details
  • PUT/operation/automation/{tenant_id}/scripts/{script_id} Update Script

    📘

    Parameter

    • Change CreateScriptRequest.platform
  • GET/operation/automation/{tenant_id}/scripts/{script_id} Describe Script

    📘

    Return Type

    • Change platform
  • POST/recommendations/{definition_id}/resolve_preexecute Resolve Recommendation Action Preexecute

    📘

    Parameter

    • Deleteaction//Specify the action to fetch data
  • POST/recommendations/{tenant_id}/resolve_preexecute/{recommendation_id} Resolve PreExecute Recommendation

    📘

    Parameter

    • Deleteaction//Specify the action to fetch data
  • POST/resource/inventory/{tenant_id}/resources Get Inventory Details

    📘

    Parameter

    • Add InventoryResourceDetailsRequest.filters.fetch_live_status//Specify to fetch the live ping status of the AWS SSM enabled instance.
  • GET/tenants List Tenant

    📘

    Return Type

    • Change tenants.status
  • PUT/tenants/{tenant_id} Update Tenant

    📘

    Parameter

    • Change UpdateTenantRequest.status
  • GET/users/filter-options List Users

    📘

    Return Type

    • Change tenants.cloud_providers.cloud_accounts.currency (Added Enum)
    • Change tenants.integrated_tool_providers.tool (Added Enum)
  • POST/v1/cost/costoptimizer/optimizerate/long_term_savings/recommended_reservations/savings_summary Saving Summary for Recommended Reservations

    📘

    Parameter

    • Change RecommendedReservationsSavingsSummaryRequest.currency (Added Enum)
  • POST/v1/cost/finops_assessment_trigger/{tenant_id}/{cloud_account_id} Finops Assessment Trigger

    📘

    Return Type

    • Add assessment_run_id//Assessment run id
    • Deletecloud_account_id//cloud account id
  • POST/v1/cost/resource_wise_billing_monthly/latest Returns the latest resource wise monthly bill for given service account and resource id

    📘

    Parameter

    • DeleteResourceWiseBillingMonthlyLatestRequest.billing_end_date//End Date of billing period

    Return Type

    • Add latest_resource_cost//Resource cost for the usage

    • Add billing_start_date//Start Date of billing period

    • Deleterate//Rate for the usage

  • GET/v1/feature_requirements/list List Feature requirements

    📘

    Return Type

    • Deleteproviders.access_policies.cloud//Cloud Provider to select
    • Change feature (Added Enum)
    • Change providers.mandatory_dependent_features
    • Change providers.optional_dependent_features
    • Change providers.ondemand_dependent_features
  • POST/v1/master_accounts

    📘

    Parameter

    • Add CreateMasterAccountRequest.sso_tenant_id//SSO tenant id
    • Add CreateMasterAccountRequest.mfa_enabled//Flag to enable MFA for the master account
    • Add CreateMasterAccountRequest.custom_tags//List of tag key/value pairs
    • Add CreateMasterAccountRequest.third_party_subscription_details//Third party subscription details
    • DeleteCreateMasterAccountRequest.subscription_info.action//Action will be create for project master creation
    • DeleteCreateMasterAccountRequest.subscription_info.subscription_id//Subscription id of user
    • DeleteCreateMasterAccountRequest.notification_settings.email_template//Email Template
    • DeleteCreateMasterAccountRequest.notification_settings.header_logo//Header Logo
    • DeleteCreateMasterAccountRequest.notification_settings.footer_text//Footer text
    • DeleteCreateMasterAccountRequest.notification_settings.template_type//Type of template
    • DeleteCreateMasterAccountRequest.notification_settings.email_settings//Email settings
  • GET/v1/master_accounts/item/{master_account_id} Master Account View

    📘

    Return Type

    • Add notification_settings//Notification settings
    • Add crm_id//CRM id
    • Add auth_config//Auth Configuration
    • Deletesegment//segment
    • Deleteindustry//industry
    • Deletecountry//country
    • Deletesize//size
    • Deleteregion//region
    • Deletesubscription_info.action//Action will be create for project master creation
    • Deletesubscription_info.subscription_id//Subscription id of user
  • GET/v1/master_accounts/{master_account_id}/tenants Tenant List by Master Account

    📘

    Return Type

    • Add status//Indicates the status of the Tenant
    • Add is_default//Is this a default tenant
  • GET/v1/products/list List Products

    📘

    Return Type

    • Change features
  • POST/v1/resource/smallest_sku_region Get unit price of smallest sku for a specific region

    📘

    Parameter

    • Change ResourceUnitPriceCheapestSkuRequest.currency (Added Enum)
  • GET/v1/role_templates/list List Role Templates

    📘

    Return Type

    • Change policies.policy (Added Enum)
    • Change integrated_tools
  • POST/v1/stacks-marketplace/products/batch Batch Stacks Marketplace Products

    📘

    Return Type

    • Add results//Map from identifier to response model
  • POST/v1/stacks-marketplace/stack-definition-versions/batch Batch Stacks Marketplace Stack Definition Versions

    📘

    Return Type

    • Add results//Map from identifier to response model
  • GET/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/publishing/{master_account_id}/history Get Stacks Marketplace Stack Definitions Version Publishing History

    📘

    Return Type

    • Add auto_publish_settings//Auto-Publish settings
  • POST/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/publishing/{master_account_id}/state Set State for Stacks Marketplace Stack Definition Version Publishing

    📘

    Parameter

    • Add StacksMarketplaceStackPublishingState.auto_publish_settings//Auto-Publish settings

    Return Type

    • Add auto_publish_settings//Auto-Publish settings
  • GET/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/publishing/{master_account_id}/state Get State for Stacks Marketplace Stack Definition Version Publishing

    📘

    Return Type

    • Add auto_publish_settings//Auto-Publish settings
  • POST/v1/stacks-marketplace/stack-definitions/batch Batch Stacks Marketplace Stack Definitions

    📘

    Return Type

    • Add results//Map from identifier to response model
  • GET/v1/stacks-marketplace/stack-definitions/item/{stack_definition_id}/history Get Stacks Marketplace Stack Definition History

    📘

    Return Type

    • Add results//Map from identifier to response model
  • POST/v1/stacks-marketplace/stack-deployment/batch Batch Stacks Marketplace Stack Deployments

    📘

    Return Type

    • Add results//Map from identifier to response model
  • POST/v1/stacks-marketplace/stack-deployment/history/batch Batch Stacks Marketplace Stack Deployment History

    📘

    Return Type

    • Add results//Map from identifier to response model
    • Deletedeployment_id//Deployment ID
    • Deletestack_version_id//Stack version ID
    • Deletestack_deployment_action//Deployment action of the resource
    • Deletejob_id//Job ID
    • Deleteinitiated_at//Initiated at
    • Deletecompleted_at//Completed at
    • Deletestatus//Deployment execution status
    • Deleteinitiated_by//Initiated by
    • Deletedistributor_id//Distributor ID
    • Deleteinput_parameters//JSON encoded string of input parameters
    • Deleterun_name//Run name
    • Deletestatus_message//Status message
  • POST/v1/stacks-marketplace/stack-deployment/item/{stack_deployment_id}/execute Execute Stacks Marketplace Stack Deployment

    📘

    Parameter

    • Add StackMarketplaceStackDeploymentExecute.estimated_cost//Estimated cost of the stack before deployment.

    Return Type

    • Add estimated_cost//Estimated cost of the stack before deployment.
  • GET/v1/user/switch_account/{master_account_id} Switch Master Account

    📘

    Return Type

    • Add user_guide_url//User Guide URL
    • Add support_url//Support URL
    • Add terms_and_conditions_url//Terms and Conditions URL
    • Add user.products//Products enabled in the master account
    • Deletealias//Alias details.
    • Deleteworkflow//Workflow details
    • Deleteis_full_access//Whether full access or not.
    • Deletedashboard_reference//Dashboard reference.
    • Deletepayment//Payment list.
    • Deleteuser.product_bundle_name//Project Bundle Name of the users.
    • Change user.crm_id
    • Change audit (Data Type)
  • GET/v1/user_details Get User session and roles details

    📘

    Return Type

    • Add user_guide_url//User Guide URL
    • Add support_url//Support URL
    • Add terms_and_conditions_url//Terms and Conditions URL
    • Add user.products//Products enabled in the master account
    • Deletealias//Alias details.
    • Deleteworkflow//Workflow details
    • Deleteis_full_access//Whether full access or not.
    • Deletedashboard_reference//Dashboard reference.
    • Deletepayment//Payment list.
    • Deleteuser.product_bundle_name//Project Bundle Name of the users.
    • Change user.crm_id
    • Change audit (Data Type)
  • POST/v1/well-architected-framework/assessment-run-question/batch Get a batch of Assessment Run History Question details

    📘

    Return Type

    • Add sync_failure_reason//Sync failure reason
    • Add answers.sync_failure_reason//Sync failure reason
  • POST/v1/well-architected-framework/assessment-run/batch Get a batch of assessment run details

    📘

    Return Type

    • Add sync_failure_reason//Sync failure reason
  • POST/v1/well-architected-framework/assessment-run/create Start an assessment run for the assessment definition

    📘

    Return Type

    • Add sync_failure_reason//Sync failure reason
  • GET/v1/well-architected-framework/assessment-run/item/{assessment_run_id} Fetch the details for an assessment run by ID

    📘

    Return Type

    • Add sync_failure_reason//Sync failure reason
  • POST/v1/well-architected-framework/assessment-run/item/{assessment_run_id}/answer Answer a question or best practice

    📘

    Parameter

    • Add WellArchitectedFrameworkAssessmentRunAnswerRequest.answer.sync_failure_reason//Sync failure reason

    Return Type

    • Add sync_failure_reason//Sync failure reason

    • Add answers.sync_failure_reason//Sync failure reason

  • POST/v1/well-architected-framework/assessment-run/item/{assessment_run_id}/set-state Set the state for an assessment run

    📘

    Return Type

    • Add sync_failure_reason//Sync failure reason
  • POST/v1/workload-query/resource/batch Returns a list of ServiceResourceInventory

    📘

    Return Type

    • Add service_resource_id//Unique identifier of the resource
  • POST/v2/audit/auditlog/list Audit List

    📘

    Parameter

    • Change AuditLogListRequest.filters.event_types
    • Change AuditLogListRequest.filters.event_actions
  • POST/v2/schedule_recommendations/filters Schedule Recommendations Filters

    📘

    Return Type

    • Change currencies
  • POST/v2/schedule_recommendations/list_resource_schedule Schedule Recommendations Resource Schedule List

    📘

    Return Type

    • Change currency (Added Enum)
  • POST/v2/schedule_recommendations/list_schedules Schedule Recommendations Schedule List

    📘

    Parameter

    • Change ScheduleRecommendationScheduleRequest.currencies
  • POST/v2/schedule_recommendations/resource_details Schedule Recommendations Resource Details

    📘

    Return Type

    • Change currency (Added Enum)
  • POST/v2/schedule_recommendations/summary Schedule Recommendations Summary

    📘

    Parameter

    • Change ScheduleRecommendationSummaryRequest.currency (Added Enum)
  • POST/v2/service_account/create Create a new Service Account

    📘

    Parameter

    • Add ServiceAccountDetails.billing_account_id//Link to Service Account that is used to retrieve billing information.
    • Change ServiceAccountDetails.currency (Added Enum)
    • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)
  • POST/v2/service_account/item/{service_account_id} Update Service Account details

    📘

    Parameter

    • Add ServiceAccountDetails.billing_account_id//Link to Service Account that is used to retrieve billing information.

    • Change ServiceAccountDetails.currency (Added Enum)

    • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)

    Return Type

    • Add billing_account_id//Link to Service Account that is used to retrieve billing information.

    • Change currency (Added Enum)

    • Change onboarded_features.feature (Added Enum)

  • GET/v2/service_account/item/{service_account_id} Get Service Account details

    📘

    Return Type

    • Add billing_account_id//Link to Service Account that is used to retrieve billing information.
    • Change currency (Added Enum)
    • Change onboarded_features.feature (Added Enum)
  • GET/v2/service_account/item/{service_account_id}/credentials_validation Validate Service Account Credentials

    📘

    Return Type

    • Add billing_account_id//Link to Service Account that is used to retrieve billing information.
    • Change currency (Added Enum)
    • Change onboarded_features.feature (Added Enum)
  • POST/v2/service_account/item/{service_account_id}/dry_run Validate update of Service Account details

    📘

    Parameter

    • Add ServiceAccountDetails.billing_account_id//Link to Service Account that is used to retrieve billing information.

    • Change ServiceAccountDetails.currency (Added Enum)

    • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)

    Return Type

    • Add billing_account_id//Link to Service Account that is used to retrieve billing information.

    • Change currency (Added Enum)

    • Change onboarded_features.feature (Added Enum)

  • 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

    • Add ServiceAccountDetails.billing_account_id//Link to Service Account that is used to retrieve billing information.

    • Change ServiceAccountDetails.currency (Added Enum)

    • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)

    Return Type

    • Add billing_account_id//Link to Service Account that is used to retrieve billing information.

    • Change currency (Added Enum)

    • Change onboarded_features.feature (Added Enum)

  • POST/v2/service_account/item/{service_account_id}/sync_status Trigger refresh of Sync Status

    📘

    Parameter

    • Add ServiceAccountSync.finops**savings_plans//Savings Plans current status

    Return Type

    • Add finops**savings_plans//Savings Plans current status
  • GET/v2/service_account/item/{service_account_id}/sync_status Get Current Sync Status

    📘

    Return Type

    • Add finops**savings_plans//Savings Plans current status
  • GET/v2/service_account/item/{service_account_id}/sync_status_history Get Sync Status History

    📘

    Return Type

    • Add finops**savings_plans//Savings Plans status history
  • POST/v2/service_account/list List Service Accounts

    📘

    Parameter

    • Add ServiceAccountListRequest.filters.include_billing_as_parent//Also include billing accounts as parents.
    • Add ServiceAccountListRequest.filters.only_restricted_cloud//Only include accounts in restricted datacenters
    • Add ServiceAccountListRequest.filters.exclude_restricted_cloud//Exclude all accounts in restricted datacenters
    • Add ServiceAccountListRequest.filters.sync_status.finops__savings_plans//Savings Plans current status
    • Change ServiceAccountListRequest.filters.currencies
    • Change ServiceAccountListRequest.filters.onboarded_any
    • Change ServiceAccountListRequest.filters.onboarded_all

Updated 15 days ago