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

External APIs 4.1 (2303 - 2304)

Released August 9, 2023

Changelog

What's New

  • PUT/cost/markups_and_discounts/{tenant_id}/create Create Cost Markup Rule
  • PUT/cost/markups_and_discounts/{tenant_id}/update Update Cost Markup Rule
  • POST/governance/guardrails/{tenant_id}/policies/batch Batch Policies
  • POST/governance/guardrails/{tenant_id}/policies/validate_parameters Validate parameters for a given policy
  • GET/operations/activity/{tenant_id}/list/{cloud_account_id} List Activities Based on Activity Configuration
  • POST/resource/tags/get_tag_keys List Tags from Resources
  • POST/user_groups/summary/batch User Group Batch
  • POST/users/summary/batch User Batch
  • POST/v1/attachment/batch Get Attachments
  • POST/v1/attachment/create Create new Attachment
  • GET/v1/attachment/item/{attachment_id} Update an Attachment
  • POST/v1/attachment/item/{attachment_id} Update an Attachment
  • POST/v1/attachment/item/{attachment_id}/stream Upload an Attachment
  • GET/v1/attachment/item/{attachment_id}/stream/{file_name} Download an Attachment
  • POST/v1/aws-security-hub/configuration Update AWS Security Hub Configuration
  • POST/v1/aws-security-hub/dashboard/findings/batch Returns a batch of Findings
  • POST/v1/aws-security-hub/dashboard/findings/list Returns a list AWS Security Hub Findings ids
  • POST/v1/aws-security-hub/findings/filters/product_name Returns list of AWS securityhub finding product names with all possible filter values for the given tenant
  • POST/v1/aws-security-hub/findings/filters/region Returns list of AWS securityhub finding Region with all possible filter values for the given cloud accounts
  • POST/v1/aws-security-hub/findings/filters/resource Returns list of AWS securityhub finding resource with all possible filter values for the given tenant
  • POST/v1/aws-security-hub/findings/filters/severity Returns list of AWS securityhub finding severity with all possible filter values for the given tenant
  • GET/v1/aws-security-hub/{cloud_account_id}/configuration Get AWS Security Hub Configuration
  • GET/v1/aws-security-hub/{cloud_account_id}/permission_validation/check Get AWS Security Hub Permission Validation Results
  • GET/v1/aws-security-hub/{cloud_account_id}/permission_validation/start Trigger AWS Security Hub Permission Validation
  • GET/v1/aws-security-hub/{cloud_account_id}/sync Get AWS Security Hub Sync Details
  • POST/v1/azure-devops/dashboard/buildlogs/list List the available logs associated with build in AzureDevops
  • POST/v1/azure-devops/dashboard/builds/list List the available builds under pipelines in AzureDevops
  • POST/v1/azure-devops/dashboard/buildworkitems/list List the available workitems associated with build in AzureDevops
  • POST/v1/azure-devops/dashboard/pipelines/list List the available projects under account in AzureDevops
  • POST/v1/azure-devops/dashboard/projects/list List the available project under AzureDevops
  • POST/v1/integrations/servicenow/cmdb_config/create Create ServiceNow CMDB Configuration
  • POST/v1/integrations/servicenow/cmdb_config/delete Delete ServiceNow CMDB Configuration
  • POST/v1/integrations/servicenow/cmdb_config/list List ServiceNow CMDB Configurations
  • POST/v1/integrations/servicenow/cmdb_config/list_cmdb_ci_class_attributes List ServiceNow CMDB CI Class Attributes
  • POST/v1/integrations/servicenow/cmdb_config/list_cmdb_ci_classes List ServiceNow CMDB CI Classes
  • POST/v1/integrations/servicenow/cmdb_config/list_inventory_attributes List Inventory Attributes for Resource
  • POST/v1/integrations/servicenow/cmdb_config/update Update ServiceNow CMDB Configuration
  • POST/v1/integrations/servicenow/cmdb_config/view View ServiceNow CMDB Configuration
  • POST/v1/integrations/servicenow/cmdb_config/view_hierarchy View Cloud Schema Hierarchy
  • GET/v1/integrations/servicenow/cmdb_sync/progress/{cloud_account_id} Cmdb Sync Progress
  • POST/v1/integrations/servicenow/cmdb_sync/trigger Trigger CMDB sync
  • POST/v1/master_accounts
  • POST/v1/master_accounts/batch
  • GET/v1/master_accounts/item/{master_account_id} Master Account View
  • DELETE/v1/master_accounts/item/{master_account_id} Master Account Delete
  • POST/v1/master_accounts/list
  • GET/v1/master_accounts/{master_account_id}/tenants Tenant List by Master Account
  • GET/v1/master_accounts/{master_account_id}/user_groups User Group List By Master Account
  • POST/v1/roles/summary/batch Role Batch
  • POST/v1/runbook/{tenant_id}/AWS/automation/{automation_id}
  • DELETE/v1/runbook/{tenant_id}/AWS/automation/{execution_id}
  • POST/v1/runbook/{tenant_id}/AWS/command/{command_id}
  • DELETE/v1/runbook/{tenant_id}/AWS/command/{instance_id}
  • POST/v1/runbook/{tenant_id}/AWS/document/{document_id}/versions/batch
  • GET/v1/runbook/{tenant_id}/AWS/document/{document_id}/versions/history
  • GET/v1/runbook/{tenant_id}/AWS/document/{document_type}/filters
  • POST/v1/runbook/{tenant_id}/AWS/documents/batch
  • POST/v1/runbook/{tenant_id}/AWS/documents/execution/batch
  • POST/v1/runbook/{tenant_id}/AWS/documents/execution/list
  • POST/v1/runbook/{tenant_id}/AWS/documents/list
  • GET/v1/runbook/{tenant_id}/AWS/execution/filters
  • POST/v1/runbook/{tenant_id}/AWS/execution/group/batch
  • POST/v1/runbook/{tenant_id}/AWS/execution/group/list
  • POST/v1/runbook/{tenant_id}/AWS/execution/instance/batch
  • POST/v1/runbook/{tenant_id}/AWS/execution/instance/list
  • POST/v1/runbook/{tenant_id}/AWS/execution/step/batch
  • GET/v1/runbook/{tenant_id}/AWS/execution/step/list/{execution_id}
  • GET/v1/user/switch_account/{master_account_id} Get Access Token
  • POST/v1/user_delegation/master_accounts/{master_account_id}/rules Create User Delegation
  • POST/v1/user_delegation/master_accounts/{master_account_id}/rules/batch Batch User Delegation
  • PUT/v1/user_delegation/master_accounts/{master_account_id}/rules/item/{rule_id} Update User Delegation
  • DELETE/v1/user_delegation/master_accounts/{master_account_id}/rules/item/{rule_id} Delete User Delegation
  • POST/v1/user_delegation/master_accounts/{master_account_id}/rules/list List User Delegation
  • GET/v1/user_delegation/master_accounts/{master_account_id}/rules/refresh Refresh User Delegation
  • GET/v1/user_delegation/report/{user_id} Get User Delegation Report
  • POST/v1/users/invite Invite User
  • POST/v1/well-architected-framework/assessment-definition/batch Get Dashboard Versions
  • POST/v1/well-architected-framework/assessment-definition/create Create new Assessment
  • GET/v1/well-architected-framework/assessment-definition/item/{assessment_id} Get Assessment Definition
  • DELETE/v1/well-architected-framework/assessment-definition/item/{assessment_id} Delete Assessment Definition
  • GET/v1/well-architected-framework/assessment-definition/item/{assessment_id}/history Get the history of an Assessment Definition
  • POST/v1/well-architected-framework/assessment-definition/item/{assessment_id}/set-state Set state of Assessment Definition
  • POST/v1/well-architected-framework/assessment-definition/list Filter Assessment Definitions
  • POST/v1/well-architected-framework/assessment-run-history/batch Get a batch of Assessment Run History details
  • POST/v1/well-architected-framework/assessment-run-history/item/{assessment_run_history_id}/violations Get a list of RecordIdentity for resources that have violated the given policy job
  • POST/v1/well-architected-framework/assessment-run-history/list Get the history IDs for the given filters
  • POST/v1/well-architected-framework/assessment-run-question/batch Get a batch of Assessment Run History Question details
  • POST/v1/well-architected-framework/assessment-run-question/list Get the Question IDs for the given 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/assessment-run/batch Get a batch of assessment run details
  • POST/v1/well-architected-framework/assessment-run/create Start an assessment run for the assessment definition
  • GET/v1/well-architected-framework/assessment-run/item/{assessment_run_id} Fetch the details for an assessment run by ID
  • POST/v1/well-architected-framework/assessment-run/item/{assessment_run_id}/answer Answer a question or best practice
  • POST/v1/well-architected-framework/assessment-run/item/{assessment_run_id}/milestone Create a milestone - take snapshot of the current state of assessment run including state of questions, best practices, comments and attachments associated alongside
  • POST/v1/well-architected-framework/assessment-run/item/{assessment_run_id}/scan Start a scan for an assessment run using the given context
  • POST/v1/well-architected-framework/assessment-run/item/{assessment_run_id}/set-state Set the state for an assessment run
  • POST/v1/well-architected-framework/assessment-run/list Get all assessment run IDs for the given filters
  • POST/v1/well-architected-framework/assessment-version/batch Get Assessment Versions
  • POST/v1/well-architected-framework/assessment-version/create Create new Assessment Definition Version
  • GET/v1/well-architected-framework/assessment-version/item/{version_id} Get Assessment Definition Version
  • GET/v1/well-architected-framework/assessment-version/item/{version_id}/make-head Make Assessment Definition Version the Head version
  • GET/v1/well-architected-framework/assessment-version/item/{version_id}/make-release Make Assessment Definition Version the Release version
  • GET/v1/well-architected-framework/assessment-version/item/{version_id}/set-state Set state of Assessment Definition Version
  • POST/v1/well-architected-framework/assessment-version/parseImport Parse Assessment Definition Version
  • POST/v1/well-architected-framework/{tenant_id}/best-practice/batch Batch Best Practices
  • POST/v1/well-architected-framework/{tenant_id}/best-practice/create Best practices Create
  • POST/v1/well-architected-framework/{tenant_id}/best-practice/update Best practice Update
  • POST/v1/well-architected-framework/{tenant_id}/framework/batch Batch Frameworks
  • POST/v1/well-architected-framework/{tenant_id}/framework/create Framework Create
  • GET/v1/well-architected-framework/{tenant_id}/framework/list List Frameworks
  • POST/v1/well-architected-framework/{tenant_id}/framework/update Framework Update
  • DELETE/v1/well-architected-framework/{tenant_id}/framework/{framework_id}/delete Framework Delete
  • POST/v1/well-architected-framework/{tenant_id}/pillar/create Add pillars to a framework
  • POST/v1/well-architected-framework/{tenant_id}/pillar/update Pillar update
  • 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
  • POST/v1/well-architected-framework/{tenant_id}/question/batch Batch Questions
  • POST/v1/well-architected-framework/{tenant_id}/question/create Create Questions for a pillar of a framework
  • POST/v1/well-architected-framework/{tenant_id}/question/update Question Update
  • POST/v1/workload-definition/batch Get Dashboard Versions
  • POST/v1/workload-definition/create Create new Workload
  • GET/v1/workload-definition/item/{workload_id} Get Workload Definition
  • DELETE/v1/workload-definition/item/{workload_id} Delete Workload Definition
  • GET/v1/workload-definition/item/{workload_id}/history Get the history of a Workload Definition
  • POST/v1/workload-definition/item/{workload_id}/set-state Set state of Workload Definition
  • POST/v1/workload-definition/list Filter Workload Definitions
  • POST/v1/workload-query/execute Returns a list of Resource identifiers based on input query
  • POST/v1/workload-query/resource/batch Returns a list of ServiceResourceInventory
  • POST/v1/workload-query/resource/filters/region Returns list of WorkloadServiceResourceRegion with all possible filter values for the given cloud accounts
  • GET/v1/workload-query/resource/filters/service-resource Returns list of WorkloadServiceResource with all possible filter values
  • POST/v1/workload-version/batch Get Workload Versions
  • POST/v1/workload-version/create Create new Workload Definition Version
  • GET/v1/workload-version/item/{version_id} Get Workload Definition Version
  • GET/v1/workload-version/item/{version_id}/make-head Make Workload Definition Version the Head version
  • GET/v1/workload-version/item/{version_id}/make-release Make Workload Definition Version the Release version
  • POST/v1/workload-version/parseImport Parse Workload Definition Version
  • DELETE/resource/locks/{tenant_id}/lock_config_rule Delete Resource Lock Config Rule
  • DELETE/resource/tags/{tenant_id}/tag_config_rule Delete Resource Tag Config Rule

What's Deprecated

  • POST/compliance/{tenant_id}/control_mapping/on_demand_bestpractice Compliance On Demand Bestpractice execute
  • POST/compliance/{tenant_id}/control_mapping/on_demand_workload_execute Compliance On Demand workload_execute
  • PUT/cost/discounts/{tenant_id}/create Create Cost Discount Rule
  • PUT/cost/discounts/{tenant_id}/update Update Cost Discount Rule
  • PUT/cost/markups/{tenant_id}/create Create Cost Markup Rule
  • PUT/cost/markups/{tenant_id}/update Update Cost Markup Rule
  • PUT/cost/ri_markups/{tenant_id}/create Create Cost RI-Markup Rule
  • PUT/cost/ri_markups/{tenant_id}/update Update Cost RI-Markup Rule
  • GET/operations/activity/{tenant_id}/list/{cloud_account_id}/{action_name} List Activities Based on Activity Configuration
  • POST/resource/tags/{tenant_id}/get_tag_keys List Tags from Resources

What's Changed

  • POST/budget/create Create Budget

    📘

    Parameter

    • Change BudgetCreateUpdateReqModel.budget_frequency
    • Change BudgetCreateUpdateReqModel.budget_amount.planned_budget_limit.month
  • POST/budget/dashboard/list_budgets View Budget Dashboard

    📘

    Parameter

    • Change BudgetListReqModel.cloud (Data Type)

    • Change BudgetListReqModel.cloud_account_id

    📘

    Return Type

    • Change budgets_list.budget_scope_details.clouds
  • PUT/budget/update Update Budget

    📘

    Parameter

    • Change BudgetCreateUpdateReqModel.budget_frequency
    • Change BudgetCreateUpdateReqModel.budget_amount.planned_budget_limit.month
  • GET/budget/{tenant_id}/{budget_id}/view List Budget Detail

    📘

    Return Type

    • Change summary.budget_amount.planned_budget_limit.month
  • POST/compliance/executive_dashboard/compliance Compliance Security Dashboard Summary

    📘

    Parameter

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

    📘

    Parameter

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

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts
  • GET/compliance/{tenant_id}/mapping/list List Compliance Control Mappings

    📘

    Parameter

    • compliance_uri change into not required
    • Change compliance_uri
  • 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}/view_recommendations Resource Wise Recommendation(Savings) Data

    📘

    Return Type

    • Add recommendation_data.resource_recommendation_id//Identifier for resource recommendation
    • Deleterecommendation_data.cloud_account_id//Cloud account id
  • POST/cost/executive_dashboard/budget_drift Get Actual or Forecast Budget Drift

    📘

    Parameter

    • Change BudgetDriftRequest.filter.clouds
  • 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_anomalies_by_cloud Get Cost Spend By Cloud and Resource Category

    📘

    Parameter

    • Change CostAnomalyByCloudRequest.filter.clouds
  • 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

    📘

    Parameter

    • Change CostTrendByCloudRequest.filter.clouds

    📘

    Return Type

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

    📘

    Parameter

    • Change CostSpendByBillingTypeRequest.filter.clouds

    📘

    Return Type

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

    📘

    Parameter

    • Change CostSpendByCloudRequest.filter.clouds

    📘

    Return Type

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

    📘

    Parameter

    • Change CostSpendByCloudAccountRequest.filter.clouds

    📘

    Return Type

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

    📘

    Parameter

    • Change CostSpendByCloudResourceCategoryRequest.filter.clouds

    📘

    Return Type

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

    📘

    Parameter

    • Change CostSpendByCloudTenantRequest.filter.clouds

    📘

    Return Type

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

    📘

    Parameter

    • Change CostSpendByRegionRequest.filter.clouds

    📘

    Return Type

    • Change cloud (Added Enum)
  • POST/cost/executive_dashboard/tagged_and_untagged_resources Get Tagged and Untagged Resources Cost By Product Category

    📘

    Parameter

    • Change TaggedUntaggedResourcesByProductCategoryRequest.filter.clouds
  • POST/cost/executive_dashboard/tagged_and_untagged_spend_by_cloud Get Tagged and Untagged Spend Cloud Wise

    📘

    Parameter

    • Change TaggedAndUntaggedResourceByCloudRequestModel.filter.clouds
  • POST/cost/executive_dashboard/tagged_untagged_trend_cost_trend Get Tag And Untag Cloudwise Trend

    📘

    Parameter

    • Change TaggedAndUntaggedCostTrendRequestModel.filter.clouds
  • POST/cost/executive_dashboard/top_budgets Get Top Budget By Tenant

    📘

    Parameter

    • Change TopBudgetByTenantRequest.filter.clouds
  • DELETE/cost/markups_and_discounts/{tenant_id}/delete Delete Cost Markup Rule

    📘

    Return Type

    • Add name//Deleted Rule name
    • Deletestatus//Status of the delete rule call
    • Deletemessage//Message of the delete rule call
    • Deletedata//Deleted Rule name
  • GET/cost/markups_and_discounts/{tenant_id}/list List Cost Markup Rules

    📘

    Return Type

    • Add start_date//Start date of the rule
    • Add end_date//End date for that rule
    • Add rule_name//Rule name. Enter an existing Rule name or else a new one will be created
    • Add rule_scope//Scope of the rule. This field cannot be updated use the same Rule Scope. If you want to update this create a new Rule
    • Add rule_type//Type of the markup/discount rule
    • Add is_active//States if the rule is active or not
    • Add markup_type//Type of the markup
    • Add markup_amount//Markup/Discount amount depending on the markup type selected
    • Add service//Cloud Provider to select
    • Add applicable_to//It is applicable to which cloud account or tenant based on rule scope. Cloud account Id can be retrieved from api(/governance/account/{tenant_id}/get/cloud_accounts) This field cannot be updated enter the same one as entered before If you want to update this create a new Rule
    • Deletedata//End date for that markup
  • PUT/cost/posture/account_or_tenant/visibility/cloud_usage_summary List Visibility Summary by Cloud Account Usage

    📘

    Parameter

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

    📘

    Parameter

    • Change ListIdentifierWiseRequest.date_filter
    • Change ListIdentifierWiseRequest.service_name (Added Enum)
  • POST/cost/posture/dashboard_summary List Dashboard Summary by Account, Tenant, Service type

    📘

    Parameter

    • Change CostDashboardSummaryRequest.date_filter
    • Change CostDashboardSummaryRequest.filter.service_type

    📘

    Return Type

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

    📘

    Parameter

    • Change CostSummaryDataReqServiceType.date_filter
  • GET/cost/posture/{tenant_id}/get_cost_hierarchy Get Cost Hierarchy

    📘

    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/ri/recommendation List Recommendations

    📘

    Parameter

    • Change ListRIRecommendationsRequest.services
  • POST/cost/schedule_recommendation/dashboard/summary List Schedule Recommendation Account Dashboard Summary

    📘

    Parameter

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

    📘

    Parameter

    • Change CostServiceFilterRequestModel.cloud_name (Added Enum)
  • 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/cloud_accounts List Cloud Accounts

    📘

    Parameter

    • Change CloudAccountListRequest.cloud_name (Added Enum)
  • POST/governance/account/{tenant_id}/create/cloud_accounts On-board Cloud Accounts

    📘

    Parameter

    • Change CloudAccountCreateRequestModel.currency
    • Change CloudAccountCreateRequestModel.metadata (Data Type)
    • Change CloudAccountCreateRequestModel.auth_values (Data Type)
  • GET/governance/account/{tenant_id}/get/cloud_accounts List Cloud Accounts

    📘

    Parameter

    • Add resource_catalog_allowed//Resource catalog enabled or not
  • PUT/governance/account/{tenant_id}/update/{cloud_account_id} Update Cloud Account

    📘

    Parameter

    • DeleteCloudAccountUpdateRequestModel.currency//Currency by which the cloud account cost is estimated.
    • Change CloudAccountUpdateRequestModel.preferred_regions (Data Type)
    • Change CloudAccountUpdateRequestModel.auth_values (Data Type)
  • POST/governance/guardrails/{tenant_id}/policies Create Policy

    📘

    Parameter

    • Change CreatePolicyRequest.engine_type (Added Enum)
  • PUT/governance/guardrails/{tenant_id}/policies/{policy_id} Update Policy

    📘

    Parameter

    • Change UpdatePolicyRequestModel.engine_type (Added Enum)
  • POST/operation/automation/templates/{tenant_id} Create Template

    📘

    Parameter

    • Change CreateTemplateReq.engine_type
  • PUT/operation/automation/{tenant_id}/templates/{template_id} Update Template

    📘

    Parameter

    • Change CreateTemplateReq.engine_type
  • POST/operation/posture/dashboard_summary List Operation Posture Details For Mobile Site

    📘

    Parameter

    • Change OperationPostureRequest.service_name (Added Enum)
  • POST/operations/activity/{tenant_id}/create Create New Activity Configuration

    📘

    Parameter

    • Change CreateActivityRequestModel.service (Added Enum)
  • GET/operations/activity/{tenant_id}/list_activity_operations List Operations Activity Details by Resource & Resource Type

    📘

    Parameter

    • resource Notes Resource name of the corresponding cloud service change into Resource name of the corresponding cloud service. Resource can be fetched from Get Resource Detail API
    • resource_type Notes Resource type of the corresponding cloud service change into Resource type of the corresponding cloud service. Resource Type can be obtained from List Operation Visibility Details
    • Change resource
    • Change resource_type
  • POST/operations/anomaly_detector/metric_anomalies/{tenant_id}/list List Metric Anomalies

    📘

    Parameter

    • Change ListMetricAnomaliesRequest.service (Added Enum)
  • POST/operations/monitoring_and_alerts/cloud_accounts/{tenant_id}/view_applied View Applied Operations Alert Configuration

    📘

    Parameter

    • Change ViewAppliedRequest.monitoring_template_uri
    • Change ViewAppliedRequest.cloud_account_id
    • Change ViewAppliedRequest.resource_type
    • Change ViewAppliedRequest.resource
    • Change ViewAppliedRequest.metric_name
    • Change ViewAppliedRequest.criticality
    • Change ViewAppliedRequest.metric_type
    • Change ViewAppliedRequest.status

    📘

    Return Type

    • Change applied_records (Data Type)
  • POST/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/resource_metric_hierarchy_configuration List Operations Resource Metric Hierarchy Configuration

    📘

    Parameter

    • Change ResourceMetricHierarchyRequest.service (Added Enum)
  • POST/operations/trend_analysis/patch_compliance Patch Compliance Report

    📘

    Parameter

    • Add PatchComplianceReportReq
    • DeletePathComplianceReportReq
  • POST/resource/inventory/{tenant_id}/count Get Inventory Count

    📘

    Parameter

    • Change CategoryCountRequest.filters.service (Added Enum)
  • POST/resource/inventory/{tenant_id}/resource_listing Get Resource Listing

    📘

    Parameter

    • Change ResourceListingRequest.cloud (Added Enum)
  • POST/resource/inventory/{tenant_id}/resources Get Inventory Details

    📘

    Parameter

    • Change InventoryResourceDetailsRequest.filters.service (Added Enum)
  • POST/resource/tags/{tenant_id}/remediation Create Resource Tag Remediation

    📘

    Parameter

    • Change CreateRemediationRequest.cloud (Added Enum)
  • POST/security/executive_dashboard/threats/by_cloud_accounts Get Threat by Cloud Accounts

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts

    📘

    Return Type

    • Change summary_by_accounts.cloud_provider (Added Enum)
  • POST/security/executive_dashboard/threats/by_region Get Threat by Region

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts

    📘

    Return Type

    • Change summary_by_cloudprovider.cloud_provider (Added Enum)
  • POST/security/executive_dashboard/threats/by_resource_category Get Threat by Resource Category

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts
  • POST/security/executive_dashboard/threats/trend_by_severity Get Threats by Trend

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts
  • POST/security/executive_dashboard/violations/by_cloud_account Get Config Violation by Cloud Account

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts

    📘

    Return Type

    • Change summary_by_accounts.cloud_provider (Added Enum)
  • POST/security/executive_dashboard/violations/by_region Get Config Violation By Region

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts

    📘

    Return Type

    • Change summary_by_cloudprovider.cloud_provider (Added Enum)
  • POST/security/executive_dashboard/violations/by_resource_category Get Config Violation by Resource Category

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts
  • POST/security/executive_dashboard/violations/trend_by_severity Get Config Violation trend by severity

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts
  • POST/security/executive_dashboard/vulnerabilities/by_cloud_account Get Vulnerability by Cloud Account

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts

    📘

    Return Type

    • Change summary_by_accounts.cloud_provider (Added Enum)
  • POST/security/executive_dashboard/vulnerabilities/by_region Get Vulnerability by Region

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts

    📘

    Return Type

    • Change summary_by_cloudprovider.cloud_provider (Added Enum)
  • POST/security/executive_dashboard/vulnerabilities/trend_by_severity Get Vulnerability by Trend

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts
  • GET/usergroups/view/{group_id} Describe UserGroup

    📘

    Return Type

    • Change updated_at
    • Change total_roles
    • Change total_users
  • GET/users/filter-options List Users

    📘

    Return Type

    • Add tenants.integrated_tool_providers
    • Add tenants.cloud_providers.cloud_accounts.status//Status of Account
    • Add tenants.cloud_providers.cloud_accounts.scope//Scope of the account
    • Change tenants.cloud_providers.cloud (Added Enum)
    • Change tenants.cloud_providers.cloud_accounts.cloud_account_id
    • Change tenants.cloud_providers.cloud_accounts.cloud_account_name
  • GET/users/list List Users

    📘

    Return Type

    • Add users.source_user_id//source user id
  • GET/users/product-bundles List Product Bundles and Role Types

    📘

    Return Type

    • Add bundle_id
    • Add bundle_code//Product bundle code
    • Change bundle_name
    • Change bundle_description
    • Change role_types
  • GET/users/view/{user_id} Describe User

    📘

    Return Type

    • Add source_user_id//source user id
  • POST/v1/auth/tokens/refresh Get Refresh Token

    📘

    Return Type

    • Change refresh_count (Data Type)
  • POST/v1/cost/costoptimizer/optimizerate/long_term_savings/recommended_reservations/savings_summary Saving Summary for Recommended Reservations

    📘

    Parameter

    • Change RecommendedReservationsSavingsSummaryRequest.services
  • POST/v1/cost/tags/list Returns a list of CostTag ids

    📘

    Parameter

    • Change CostTagListRequest.filters.clouds
  • GET/v1/executive_dashboard/all Get all Dashboard Definitions

    📘

    Return Type

    • Change sysId
    • Change lastUpdate
    • Change table
  • POST/v1/executive_dashboard/batch Get Dashboard Definitions

    📘

    Parameter

    • Change RecordIdentityBatchRequest.ids.sysId
    • Change RecordIdentityBatchRequest.ids.lastUpdate
    • Change RecordIdentityBatchRequest.ids.table

    📘

    Return Type

    • Change user.sysId
    • Change user.lastUpdate
    • Change user.table
    • Change headVersion.sysId
    • Change headVersion.lastUpdate
    • Change headVersion.table
    • Change releaseVersion.sysId
    • Change releaseVersion.lastUpdate
    • Change releaseVersion.table
  • POST/v1/executive_dashboard/create Create new Dashboard Definition

    📘

    Return Type

    • Change user.sysId
    • Change user.lastUpdate
    • Change user.table
    • Change headVersion.sysId
    • Change headVersion.lastUpdate
    • Change headVersion.table
    • Change releaseVersion.sysId
    • Change releaseVersion.lastUpdate
    • Change releaseVersion.table
  • GET/v1/executive_dashboard/item/{dashboard_id} Get Dashboard Definition

    📘

    Return Type

    • Change user.sysId
    • Change user.lastUpdate
    • Change user.table
    • Change headVersion.sysId
    • Change headVersion.lastUpdate
    • Change headVersion.table
    • Change releaseVersion.sysId
    • Change releaseVersion.lastUpdate
    • Change releaseVersion.table
  • GET/v1/executive_dashboard/item/{dashboard_id}/history Get the history of a Dashboard Definition

    📘

    Return Type

    • Change definition.sysId
    • Change definition.lastUpdate
    • Change definition.table
    • Change predecessor.sysId
    • Change predecessor.lastUpdate
    • Change predecessor.table
  • GET/v1/executive_dashboard/portals/resolve Resolve a portal path to its Dashboard Definition version

    📘

    Return Type

    • Change sysId
    • Change lastUpdate
    • Change table
  • POST/v1/executive_dashboard_version/batch Get Dashboard Versions

    📘

    Parameter

    • Change RecordIdentityBatchRequest.ids.sysId
    • Change RecordIdentityBatchRequest.ids.lastUpdate
    • Change RecordIdentityBatchRequest.ids.table

    📘

    Return Type

    • Change definition.sysId
    • Change definition.lastUpdate
    • Change definition.table
    • Change predecessor.sysId
    • Change predecessor.lastUpdate
    • Change predecessor.table
  • POST/v1/executive_dashboard_version/create Create new Dashboard Definition Version

    📘

    Parameter

    • Change DashboardDefinitionVersion.definition.sysId
    • Change DashboardDefinitionVersion.definition.lastUpdate
    • Change DashboardDefinitionVersion.definition.table
    • Change DashboardDefinitionVersion.predecessor.sysId
    • Change DashboardDefinitionVersion.predecessor.lastUpdate
    • Change DashboardDefinitionVersion.predecessor.table

    📘

    Return Type

    • Change definition.sysId
    • Change definition.lastUpdate
    • Change definition.table
    • Change predecessor.sysId
    • Change predecessor.lastUpdate
    • Change predecessor.table
  • GET/v1/executive_dashboard_version/item/{version_id} Get Dashboard Definition Version

    📘

    Return Type

    • Change definition.sysId
    • Change definition.lastUpdate
    • Change definition.table
    • Change predecessor.sysId
    • Change predecessor.lastUpdate
    • Change predecessor.table
  • GET/v1/executive_dashboard_version/item/{version_id}/make-head Make Dashboard Definition Version the Head version

    📘

    Return Type

    • Change definition.sysId
    • Change definition.lastUpdate
    • Change definition.table
    • Change predecessor.sysId
    • Change predecessor.lastUpdate
    • Change predecessor.table
  • GET/v1/executive_dashboard_version/item/{version_id}/make-release Make Dashboard Definition Version the Release version

    📘

    Return Type

    • Change definition.sysId
    • Change definition.lastUpdate
    • Change definition.table
    • Change predecessor.sysId
    • Change predecessor.lastUpdate
    • Change predecessor.table
  • GET/v1/tag_baseline/all Get all Tag Baseline Definitions

    📘

    Return Type

    • Change sysId
    • Change lastUpdate
    • Change table
  • POST/v1/tag_baseline/batch Get Baselines

    📘

    Parameter

    • Change RecordIdentityBatchRequest.ids.sysId
    • Change RecordIdentityBatchRequest.ids.lastUpdate
    • Change RecordIdentityBatchRequest.ids.table

    📘

    Return Type

    • Change headVersion.sysId
    • Change headVersion.lastUpdate
    • Change headVersion.table
    • Change releaseVersion.sysId
    • Change releaseVersion.lastUpdate
    • Change releaseVersion.table
  • POST/v1/tag_baseline/create Create new Tag Baseline

    📘

    Return Type

    • Change headVersion.sysId
    • Change headVersion.lastUpdate
    • Change headVersion.table
    • Change releaseVersion.sysId
    • Change releaseVersion.lastUpdate
    • Change releaseVersion.table
  • GET/v1/tag_baseline/item/{baseline_id} Get Tag Baseline Definition

    📘

    Return Type

    • Change headVersion.sysId
    • Change headVersion.lastUpdate
    • Change headVersion.table
    • Change releaseVersion.sysId
    • Change releaseVersion.lastUpdate
    • Change releaseVersion.table
  • GET/v1/tag_baseline/item/{baseline_id}/history Get the history of a Tag Baseline Definition

    📘

    Return Type

    • Change definition.sysId
    • Change definition.lastUpdate
    • Change definition.table
    • Change predecessor.sysId
    • Change predecessor.lastUpdate
    • Change predecessor.table
  • GET/v1/tag_baseline/item/{baseline_id}/set-state Set state of Tag Baseline Definition

    📘

    Return Type

    • Change headVersion.sysId
    • Change headVersion.lastUpdate
    • Change headVersion.table
    • Change releaseVersion.sysId
    • Change releaseVersion.lastUpdate
    • Change releaseVersion.table
  • POST/v1/tag_baseline_version/batch Get Dashboard Versions

    📘

    Parameter

    • Change RecordIdentityBatchRequest.ids.sysId
    • Change RecordIdentityBatchRequest.ids.lastUpdate
    • Change RecordIdentityBatchRequest.ids.table

    📘

    Return Type

    • Change definition.sysId
    • Change definition.lastUpdate
    • Change definition.table
    • Change predecessor.sysId
    • Change predecessor.lastUpdate
    • Change predecessor.table
  • POST/v1/tag_baseline_version/create Create new Tag Baseline Definition Version

    📘

    Parameter

    • Change TagBaselineDefinitionVersion.definition.sysId
    • Change TagBaselineDefinitionVersion.definition.lastUpdate
    • Change TagBaselineDefinitionVersion.definition.table
    • Change TagBaselineDefinitionVersion.predecessor.sysId
    • Change TagBaselineDefinitionVersion.predecessor.lastUpdate
    • Change TagBaselineDefinitionVersion.predecessor.table

    📘

    Return Type

    • Change definition.sysId
    • Change definition.lastUpdate
    • Change definition.table
    • Change predecessor.sysId
    • Change predecessor.lastUpdate
    • Change predecessor.table
  • GET/v1/tag_baseline_version/item/{version_id} Get Tag Baseline Definition Version

    📘

    Return Type

    • Change definition.sysId
    • Change definition.lastUpdate
    • Change definition.table
    • Change predecessor.sysId
    • Change predecessor.lastUpdate
    • Change predecessor.table
  • GET/v1/tag_baseline_version/item/{version_id}/make-head Make Tag Baseline Definition Version the Head version

    📘

    Return Type

    • Change definition.sysId
    • Change definition.lastUpdate
    • Change definition.table
    • Change predecessor.sysId
    • Change predecessor.lastUpdate
    • Change predecessor.table
  • GET/v1/tag_baseline_version/item/{version_id}/make-release Make Tag Baseline Definition Version the Release version

    📘

    Return Type

    • Change definition.sysId
    • Change definition.lastUpdate
    • Change definition.table
    • Change predecessor.sysId
    • Change predecessor.lastUpdate
    • Change predecessor.table
  • POST/v1/tag_baselines/available_tags/list Returns a list of AvailableTags ids

    📘

    Parameter

    • Change TagBaselineAvailableTagListRequest.filters.filters.clouds
  • POST/v1/tag_posture/snapshot/item/{snapshot_id}/summary/cloud_account/list Returns a list of TagPostureCloudAccountSummary identifiers based on input filters

    📘

    Parameter

    • Change TagPostureSummaryListRequest.filters.filter.clouds
  • POST/v1/tag_posture/snapshot/item/{snapshot_id}/summary/resource/list Returns a list of TagPostureResourceSummary identifiers based on input filters

    📘

    Parameter

    • Change TagPostureSummaryListRequest.filters.filter.clouds
  • GET/v1/user_details Get User session and roles details

    📘

    Return Type

    • Add user.master_account_ids//list of master account ids
  • POST/v2/security/executive_dashboard/access/by_cloud_account Get Access Violation by Cloud Account

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts

    📘

    Return Type

    • Change cloud_provider (Added Enum)
  • POST/v2/security/executive_dashboard/access/by_region Get Access Violation By Region

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts

    📘

    Return Type

    • Change cloud_provider (Added Enum)
  • POST/v2/security/executive_dashboard/access/trend_by_severity Get Access Violation trend by severity

    📘

    Parameter

    • Change SecurityDashboardRequest.filter.tenants
    • Change SecurityDashboardRequest.filter.clouds
    • Change SecurityDashboardRequest.filter.cloud_accounts
  • PUT/cost/posture/account_or_tenant/visibility/cloud_usage_summary List Visibility Summary by Cloud Account Usage

    📘

    Parameter

    • Change ListIdentifierWiseRequest.date_filter
  • PUT/cost/posture/account_or_tenant/visibility/identifier_wise_cost List Visibility Summary by Identifier

    📘

    Parameter

    • Change ListIdentifierWiseRequest.date_filter
  • POST/cost/posture/dashboard_summary List Dashboard Summary by Account, Tenant, Service type

    📘

    Parameter

    • Change CostDashboardSummaryRequest.date_filter
  • PUT/cost/posture/service_type List Dashboard Summary by Cloud

    📘

    Parameter

    • Change CostSummaryDataReqServiceType.date_filter
  • GET/users/list List Users

    📘

    Parameter

    • Add master_account_id//Specify the master account id