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

External APIs 4.0 (2301)

Changelog

What's New

  • POST/compliance/executive_dashboard/compliance Compliance Control Health by Control Categories
  • POST/compliance/executive_dashboard/control_health Compliance Control Health by Control Categories
  • POST/compliance/executive_dashboard/risk Compliance Risks By Cloud Accounts
  • POST/compliance/{tenant_id}/compliance_control_mapping/get_assessment_job_details List compliance control mapping, get_assessment_job_details
  • POST/security/executive_dashboard/threats/by_resource_category Get Threat by Resource Category
  • POST/security/executive_dashboard/violations/by_cloud_account Get Config Violation by Cloud Account
  • POST/security/executive_dashboard/violations/by_region Get Config Violation By Region
  • POST/security/executive_dashboard/violations/by_resource_category Get Config Violation by Resource Category
  • POST/security/executive_dashboard/violations/trend_by_severity Get Config Violation trend by severity
  • GET/self_service/{tenant_id}/catalog/{cloud_account_id} Create Service Catalog
  • DELETE/self_service/{tenant_id}/catalog/{cloud_account_id} Delete Service Catalog
  • PUT/users/profile/active-tenant Update active tenant for a user
  • POST/v1/background_job/batch Returns a batch of BackgroundJobs
  • POST/v1/background_job/list Returns a list of BackgroundJobs ids
  • POST/v1/background_job/log Returns a batch of log entries for BackgroundJob
  • GET/v1/background_job/stats Returns a list of BackgroundJobs ids
  • POST/v1/cost/costoptimizer/optimizerate/long_term_savings/recommended_reservations/savings_summary Saving Summary for Recommended Reservations
  • POST/v1/executive_dashboard/batch Get Dashboard Definitions
  • GET/v1/executive_dashboard/item/{dashboard_id} Get Dashboard Definition
  • DELETE/v1/executive_dashboard/item/{dashboard_id} Delete Dashboard Definition
  • GET/v1/executive_dashboard/item/{dashboard_id}/acl Get Dashboard Definition ACL
  • PUT/v1/executive_dashboard/item/{dashboard_id}/acl Update Dashboard Definition ACL
  • DELETE/v1/executive_dashboard/item/{dashboard_id}/acl Delete Dashboard Definition
  • GET/v1/executive_dashboard/item/{dashboard_id}/acl_context Evaluate Dashboard Definition ACL context
  • GET/v1/executive_dashboard/item/{dashboard_id}/acl_eval Evaluate Dashboard Definition ACL
  • GET/v1/executive_dashboard/item/{dashboard_id}/history Get the history of a Dashboard Definition
  • POST/v1/executive_dashboard_version/batch Get Dashboard Versions
  • GET/v1/executive_dashboard_version/item/{version_id} Get Dashboard Definition Version
  • GET/v1/executive_dashboard_version/item/{version_id}/make-head Make Dashboard Definition Version the Head version
  • GET/v1/executive_dashboard_version/item/{version_id}/make-release Make Dashboard Definition Version the Release version
  • POST/v1/tag_baseline/batch Get Dashboard Versions
  • GET/v1/tag_baseline/item/{baseline_id} Get Tag Baseline Definition
  • DELETE/v1/tag_baseline/item/{baseline_id} Delete Tag Baseline Definition
  • GET/v1/tag_baseline/item/{baseline_id}/history Get the history of a Tag Baseline Definition
  • GET/v1/tag_baseline/item/{baseline_id}/set-state Set state of Tag Baseline Definition
  • POST/v1/tag_baseline_version/batch Get Dashboard Versions
  • GET/v1/tag_baseline_version/item/{version_id} Get Tag Baseline Definition Version
  • GET/v1/tag_baseline_version/item/{version_id}/make-head Make Tag Baseline Definition Version the Head version
  • GET/v1/tag_baseline_version/item/{version_id}/make-release Make Tag Baseline Definition Version the Release version
  • POST/v2/security/executive_dashboard/access/by_cloud_account Get Access Violation by Cloud Account
  • POST/v2/security/executive_dashboard/access/by_region Get Access Violation By Region
  • POST/v2/security/executive_dashboard/access/trend_by_severity Get Access Violation trend by severity

What's Deprecated

  • POST/compliance/{tenant_id}/compliance_control_mapping/get_assessment_job_details' List compliance control mapping, get_assessment_job_details
  • GET/self_service/{tenant_id}/catalog/{cloud_id} Create Service Catalog
  • PUT/self_service/{tenant_id}/catalog/{cloud_id} Delete Service Catalog
  • GET/v1/executive_dashboard/item/{id} Get Dashboard Definition
  • DELETE/v1/executive_dashboard/item/{id} Delete Dashboard Definition
  • GET/v1/executive_dashboard/item/{id}/acl Get Dashboard Definition ACL
  • PUT/v1/executive_dashboard/item/{id}/acl Update Dashboard Definition ACL
  • DELETE/v1/executive_dashboard/item/{id}/acl Delete Dashboard Definition
  • GET/v1/executive_dashboard/item/{id}/acl_context Evaluate Dashboard Definition ACL context
  • GET/v1/executive_dashboard/item/{id}/acl_eval Evaluate Dashboard Definition ACL
  • GET/v1/executive_dashboard/item/{id}/history Get the history of a Dashboard Definition
  • GET/v1/executive_dashboard_version/item/{id} Get Dashboard Definition Version
  • GET/v1/executive_dashboard_version/item/{id}/make-head Make Dashboard Definition Version the Head version
  • GET/v1/executive_dashboard_version/item/{id}/make-release Make Dashboard Definition Version the Release version
  • GET/v1/tag_baseline/item/{id} Get Tag Baseline Definition
  • DELETE/v1/tag_baseline/item/{id} Delete Tag Baseline Definition
  • GET/v1/tag_baseline/item/{id}/history Get the history of a Tag Baseline Definition
  • GET/v1/tag_baseline/item/{id}/set-state Set state of Tag Baseline Definition
  • GET/v1/tag_baseline_version/item/{id} Get Tag Baseline Definition Version
  • GET/v1/tag_baseline_version/item/{id}/make-head Make Tag Baseline Definition Version the Head version
  • GET/v1/tag_baseline_version/item/{id}/make-release Make Tag Baseline Definition Version the Release version

What's Changed

  • POST/budget/create Create Budget

📘

Parameter

Change BudgetCreateUpdateReqModel.budget_details.currency (Added Enum)

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

📘

Parameter

Change BudgetSummaryReqModel.filter_params.currency (Added Enum)

  • POST/budget/dashboard/budget_summary_count View Count Budget Summary

📘

Parameter

Change BudgetSummaryReqModel.filter_params.currency (Added Enum)

  • POST/budget/dashboard/list_budgets View Budget Dashboard

📘

Parameter

Change BudgetListReqModel.currency (Added Enum)

  • PUT/budget/update Update Budget

📘

Parameter

Change BudgetCreateUpdateReqModel.budget_details.currency (Added Enum)

  • GET/budget/{budget_id}/view List Budget Detail

📘

Return Type

Change summary.budget_details.currency (Added Enum)

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

📘

Parameter

Change ComplianceControlReqModel.cloud_accounts

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

📘

Parameter

Change ComplianceStandardReqModel.cloud_accounts

  • PUT/cost/cost_savings/accounts List Cost Savings Account Summary

📘

Parameter

Change BillingAccountSummaryRequest.currency (Added Enum)

  • PUT/cost/cost_savings/accounts/visibility/{tenant_id} List Cost Saving Recommendation

📘

Parameter

  • Add ListRecommendationsRequestModel.classification//Classifications based on OSCAR pillars. Accepted values: Operation, Security, Cost, Access, Resource
  • DeleteListRecommendationsRequestModel.classifications//Classifications based on OSCAR pillars. Accepted values: Operation, Security, Cost, Access, Resource
  • DeleteListRecommendationsRequestModel.currency//currency of the cost. Example 'currency':'USD'
  • Change ListRecommendationsRequestModel.sub_classification
  • GET/cost/cost_savings/cost_saved_recommendation List Cost Saving Recommendations

📘

Parameter

Change currency

  • PUT/cost/cost_savings/tenants List Cost Savings Tenant Summary

📘

Parameter

Change BillingAccountSummaryRequest.currency (Added Enum)

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

📘

Parameter

  • Change ListRecommendationsTenantRequestModel.sub_classification
  • Change ListRecommendationsTenantRequestModel.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

  • Add LicenseBenefitSavingRequest.tenant_id//Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
  • Change LicenseBenefitSavingRequest.currency (Added Enum)
  • GET/cost/costoptimizer/optimizeusage/{tenant_id}/cloud_accounts View Cloud Account_ID and Cloud Account Name

📘

Parameter

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

📘

Parameter

  • currency change into required
  • Change currency
  • POST/cost/costoptimizer/optimizeusage/{tenant_id}/view_recommendations Resource Wise Recommendation(Savings) Data

📘

Parameter

  • Add CostOptimizationReqViewRecommendation
  • DeleteCostoptimizationReqViewRecommendation
  • PUT/cost/discounts/{tenant_id}/create Create Cost Discount Rule

📘

Parameter

  • Add CreateMarkupsRequest
  • DeleteUpdateMarkupsRequest
  • PUT/cost/discounts/{tenant_id}/update Update Cost Discount Rule

📘

Parameter

  • Add UpdateMarkupsRequest.service//Cloud Provider to select
  • Change UpdateMarkupsRequest.end_date
  • Change UpdateMarkupsRequest.rule_name
  • Change UpdateMarkupsRequest.is_active
  • Change UpdateMarkupsRequest.rule_scope
  • Change UpdateMarkupsRequest.discount_percentage
  • Change UpdateMarkupsRequest.start_date
  • POST/cost/executive_dashboard/budget_drift Get Actual or Forecast Budget Drift

📘

Parameter

Change BudgetDriftRequest.currency (Added Enum)

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

📘

Parameter

Change CloudForecasterForSixMonthsRequest.currency (Added Enum)

  • POST/cost/executive_dashboard/cost_anomalies_by_cloud Get Cost Spend By Cloud and Resource Category

📘

Parameter

Change CostAnomalyByCloudRequest.currency (Added Enum)

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

📘

Parameter

Change CostOptimizationByOptimizationTypesRequest.currency (Added Enum)

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

📘

Parameter

Change CostOptimizationTrendRequest.currency (Added Enum)

  • POST/cost/executive_dashboard/cost_trend_by_cloud Get Cost Trend By Cloud

📘

Parameter

Change CostTrendByCloudRequest.currency (Added Enum)

  • POST/cost/executive_dashboard/geo_coordinates_for_regions geo cordinates for regions

📘

Return Type

Add normalized_region

  • POST/cost/executive_dashboard/spend-by-billing-type Get Cost Spend By Billing Type

📘

Parameter

Change CostSpendByBillingTypeRequest.currency (Added Enum)

  • POST/cost/executive_dashboard/spend-by-cloud Get Cost Spend By Cloud

📘

Parameter

Change CostSpendByCloudRequest.currency (Added Enum)

  • POST/cost/executive_dashboard/spend-by-cloud-account Get Cost Spend By Cloud Account

📘

Parameter

Change CostSpendByCloudAccountRequest.currency (Added Enum)

  • POST/cost/executive_dashboard/spend_by_cloud_resource_category Get Cost Spend By Cloud and Resource Category

📘

Parameter

Change CostSpendByCloudResourceCategoryRequest.currency (Added Enum)

  • POST/cost/executive_dashboard/spend_by_cloud_tenant Get Cost Spend By Cloud and Tenant

📘

Parameter

Change CostSpendByCloudTenantRequest.currency (Added Enum)

  • POST/cost/executive_dashboard/spend_by_region Get Cost Spend By Region

📘

Parameter

Change CostSpendByRegionRequest.currency (Added Enum)

  • POST/cost/executive_dashboard/tagged_and_untagged_resources Get Tagged and Untagged Resources Cost By Product Category

📘

Parameter

Change TaggedUntaggedResourcesByProductCategoryRequest.currency (Added Enum)

  • POST/cost/executive_dashboard/tagged_and_untagged_spend_by_cloud Get Tagged and Untagged Spend Cloud Wise

📘

Parameter

Change TaggedAndUntaggedResourceByCloudRequestModel.currency (Added Enum)

  • POST/cost/executive_dashboard/tagged_untagged_trend_cost_trend Get Tag And Untag Cloudwise Trend

📘

Parameter

Change TaggedAndUntaggedCostTrendRequestModel.currency (Added Enum)

  • POST/cost/executive_dashboard/top_budgets Get Top Budget By Tenant

📘

Parameter

Change TopBudgetByTenantRequest.currency (Added Enum)

  • PUT/cost/markups/{tenant_id}/create Create Cost Markup Rule

📘

Parameter

  • Add CreateMarkupsRequest
  • DeleteUpdateMarkupsRequest
  • PUT/cost/markups/{tenant_id}/update Update Cost Markup Rule

📘

Parameter

  • Add UpdateMarkupsRequest.service//Cloud Provider to select
  • Change UpdateMarkupsRequest.end_date
  • Change UpdateMarkupsRequest.rule_name
  • Change UpdateMarkupsRequest.is_active
  • Change UpdateMarkupsRequest.rule_scope
  • Change UpdateMarkupsRequest.discount_percentage
  • Change UpdateMarkupsRequest.start_date
  • 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)

  • 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 CostSummaryEAOrCSPReqModel.currency (Added Enum)

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

📘

Parameter

Change CostSummaryEAOrCSPVisibilityReqModel.currency (Added Enum)

  • PUT/cost/posture/service_type List Dashboard Summary by Cloud

📘

Parameter

Change CostSummaryDataReqServiceType.currency (Added Enum)

  • 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

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

📘

Parameter

  • Add CreateMarkupsRequest
  • DeleteUpdateMarkupsRequest
  • PUT/cost/ri_markups/{tenant_id}/update Update Cost RI-Markup Rule

📘

Parameter

  • Add UpdateMarkupsRequest.service//Cloud Provider to select
  • Change UpdateMarkupsRequest.end_date
  • Change UpdateMarkupsRequest.rule_name
  • Change UpdateMarkupsRequest.is_active
  • Change UpdateMarkupsRequest.rule_scope
  • Change UpdateMarkupsRequest.discount_percentage
  • Change UpdateMarkupsRequest.start_date
  • GET/cost/schedule_recommendation/dashboard/summary List Schedule Recommendation Account Dashboard Summary

📘

Parameter

Change currency

  • GET/cost/schedule_recommendation/resource/summary List Schedule Recommendation Resource Dashboard Summary

📘

Parameter

Change currency

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

📘

Parameter

  • Change CostAnomalySummaryRequest.currency (Added Enum)
  • Change CostAnomalySummaryRequest.start_date
  • Change CostAnomalySummaryRequest.end_date
  • POST/cost_anomaly/rule_based_cost_anomaly Get Account wise daily Rule Cost Anomaly

📘

Parameter

  • Change CostAnomalySummaryRequest.currency (Added Enum)
  • Change CostAnomalySummaryRequest.start_date
  • Change CostAnomalySummaryRequest.end_date
  • POST/governance/account/settings/access/post/{tenant_id} Assessment Validation

📘

Parameter

Change AssessmentValidationRequest.category

  • POST/governance/account/{tenant_id}/create/cloud_accounts On-board Cloud Accounts

📘

Parameter

  • Change CloudAccountCreateRequestModel.currency (Added Enum)
  • Change CloudAccountCreateRequestModel.metadata
  • Change CloudAccountCreateRequestModel.auth_values
  • POST/governance/account/{tenant_id}/create/validate&summary Validate Cloud Account Auth Credentials

📘

Parameter

Change ValidationRequestDataModel.auth_values

  • POST/governance/account/{tenant_id}/create/{cloud_account_id}/assessment_validation_result Assessment Validation Details

📘

Parameter

Change AssessmentValidationRequestDataModel.category (Added Enum)

  • POST/governance/account/{tenant_id}/create/{cloud_account_id}/revalidate_assessment Assessment Re-Validation

📘

Parameter

Change AssessmentValidationRequestDataModel.category (Added Enum)

  • GET/governance/account/{tenant_id}/get/validate&summary Cloud Accounts Summary

📘

Return Type

Change cloudwise_summary

  • GET/governance/account/{tenant_id}/get/{cloud_account_id}/list_child_accounts List Child Accounts

📘

Return Type

Change child_accounts

  • PUT/governance/account/{tenant_id}/update/{cloud_account_id} Update Cloud Account

📘

Parameter

  • Change CloudAccountUpdateRequestModel.currency (Added Enum)
  • Change CloudAccountUpdateRequestModel.preferred_regions
  • Change CloudAccountUpdateRequestModel.auth_values
  • PUT/governance/account/{tenant_id}/update/{parent_account_id}/onboard_csp_subscription On-Boarding CSP Subscription

📘

Parameter

Change CSPOnboardSubscriptionRequestModel.auth_values

  • GET/governance/guardrails/policies/{tenant_id}/list List Policy Schedules

📘

Return Type

  • Change schedules.id
  • Change schedules.name
  • POST/operation/automation/scripts/{tenant_id}/execute Execute Script

📘

Parameter

  • DeleteExecuteScriptRequest.config_type//Config type of the script(s)
  • Change ExecuteScriptRequest.host_details.playbook_hosts
  • POST/operation/automation/templates/{tenant_id} Create Template

📘

Parameter

  • Add CreateTemplateReq.blueprint_support//Flag to add template to blueprints
  • DeleteCreateTemplateReq.blueprint_enabled//Flag to add template to blueprints
  • GET/operation/automation/{tenant_id}/scripts/{script_id} Describe Script

📘

Return Type

Change updated_at

  • PUT/operation/automation/{tenant_id}/templates/{template_id} Update Template

📘

Parameter

  • Add CreateTemplateReq.blueprint_support//Flag to add template to blueprints
  • DeleteCreateTemplateReq.blueprint_enabled//Flag to add template to blueprints
  • POST/operations/automation/blueprints/{tenant_id}/create Create Blueprints

📘

Parameter

  • Add CreateBlueprintRequest
  • DeleteCreateblueprintRequest
  • PUT/operations/automation/blueprints/{tenant_id}/update/{blueprint_id} Update Blueprints

📘

Parameter

  • Add CreateBlueprintRequest
  • DeleteCreateblueprintRequest
  • GET/operations/automation/{tenant_id}/list List Template and Script Schedules

📘

Return Type

  • Change schedules.id
  • Change schedules.name
  • PUT/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/edit_template Update Operations Alert Configuration Template

📘

Parameter

Change EditTemplateRequest.configuration_data

  • POST/resource/business_applications/applications/{tenant_id}/create Create Application in Business Application

📘

Parameter

Change CreateApplicationsRequest.cloud_account_details

  • PUT/resource/business_applications/applications/{tenant_id}/update/{application_id} Update Application in Business Application

📘

Parameter

Change CreateApplicationsRequest.cloud_account_details

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

📘

Parameter

  • Add CategoryCountRequest.filters.default_value//Default value [by default: false] If default = true, displays count only for that particular default_resource/default_category If default = false, displays count for all the category/resource except that mentioned in default_resource/default_category.
  • DeleteCategoryCountRequest.filters.default//Default value
  • Change CategoryCountRequest.filters.category
  • Change CategoryCountRequest.filters.default_resource
  • Change CategoryCountRequest.filters.default_category
  • GET/resource/inventory/{tenant_id}/rediscover Inventory Trigger Re-discovery

📘

Return Type

  • Change data.service_account_name
  • Change data.created_by
  • Change data.service_account_id
  • Change data.service_id
  • Change data.service_type
  • Change data.message
  • Change data.tenant_id
  • POST/resource/inventory/{tenant_id}/resources Get Inventory Details

📘

Parameter

  • Change InventoryResourceDetailsRequest.filters.category
  • Change InventoryResourceDetailsRequest.filters.component
  • Change InventoryResourceDetailsRequest.filters.resource
  • Change InventoryResourceDetailsRequest.filters.operation_id
  • POST/resource/tags/{tenant_id}/remediation_status/{cloud} Get Resource Tag Remediation Status

📘

Parameter

  • Change GetRemediationStatusRequestModel.resource_category
  • Change GetRemediationStatusRequestModel.resource_type
  • Change GetRemediationStatusRequestModel.resource
  • Change GetRemediationStatusRequestModel.resource_filter
  • Change GetRemediationStatusRequestModel.resource_id
  • GET/resource/{tenant_id}/locks/{cloud}/get_filters List Resource Lock Config Rule Filters

📘

Parameter

  • Add zone//to list zone of cloud account
  • Change resources
  • Change region
  • Change applicability_by
  • Change tags
  • Change resource_group
  • Change is_tag_wise

📘

Return Type

  • Add scope//ID of resource filter
  • Add applicability_by//List applicability filters of cloud account
  • Add tag_keys//Get tags keys of cloud account
  • Add regions//List of regions of cloud account
  • Add resources//Get resource filters of cloud account
  • Add resource_groups//List of resource groups of cloud account
  • Add zone//List zone of cloud account
  • Deletestatus//Status of the Lock filters
  • Deletemessage//Message of the Lock filters
  • Deletedata//scope of Lock filters
  • POST/resources/business_applications/application_group/create/{tenant_id} Create Application Group in Business Application

📘

Parameter

Change CreateApplicationGroupRequest.cloud_account_details

  • PUT/resources/business_applications/application_group/{tenant_id}/update/{application_group_id} Update Application Group in Business Application

📘

Parameter

Change CreateApplicationGroupRequest.cloud_account_details

  • POST/resources/business_applications/cost_center/create/{tenant_id} Create Cost Center in Business Application

📘

Parameter

Change CreateCostCenterRequest.cloud_account_details

  • PUT/resources/business_applications/cost_center/{tenant_id}/update/{cost_center_id} Update Cost Center in Business Application

📘

Parameter

Change CreateCostCenterRequest.cloud_account_details

  • POST/resources/business_applications/environment/create/{tenant_id} Create Environment in Business Application

📘

Parameter

Change CreateEnvironmentRequest.cloud_account_details

  • PUT/resources/business_applications/environment/{tenant_id}/update/{environment_id} Update Environment in Business Application

📘

Parameter

Change CreateEnvironmentRequest.cloud_account_details

  • POST/resources/business_applications/tag_pattern/create/{tenant_id} Create Tag Pattern in Business Application

📘

Parameter

Change CreateTagPatternsRequest.cloud_account_details

  • GET/resources/business_applications/tag_pattern/list/{tenant_id}/ List Tag Pattern in Business Application

📘

Return Type

  • Deletetagpatterns.tagpattern_id//Unique ID of the Tag pattern.
  • Deletetagpatterns.name//Name of the tag pattern.
  • Deletetagpatterns.scope//Scope of the tag pattern [Cloud Account,Tenant]
  • Deletetagpatterns.match_type//Match type of the tag pattern [StringMatch, Regex]
  • Deletetagpatterns.tag_key//Tag key associated with the tag pattern.
  • Deletetagpatterns.tag_value_mapper//Tag value mapper of the tag pattern [Environment,Application,ApplicationGroup,CostCenter]
  • Deletetagpatterns.created_at//Created date of the tag pattern in UTC
    Deletetagpatterns.updated_at//Latest updated date of the tag pattern in UTC
  • Deletetagpatterns.auto_create//Is it auto create or not
  • PUT/resources/business_applications/tag_pattern/{tenant_id}/update/{tagpattern_id} Update Tag Pattern in Business Application

📘

Parameter

Change CreateTagPatternsRequest.cloud_account_details

  • POST/security/executive_dashboard/threats/by_cloud_accounts Get Threat by Cloud Accounts

📘

Parameter

  • Add SecurityDashboardRequest
  • DeleteSecurityDashboardByTrendRequest

📘

Return Type

  • Deletesummary_by_accounts.count_by_severity.high//Threats High Total Count
  • Deletesummary_by_accounts.count_by_severity.medium//Threats Medium Total Count
  • Deletesummary_by_accounts.count_by_severity.low//Threats Low Total Count
  • POST/security/executive_dashboard/threats/by_region Get Threat by Region

📘

Parameter

  • Add SecurityDashboardRequest
  • DeleteSecurityDashboardByTrendRequest

📘

Return Type

  • Deletesummary_by_cloudprovider.cloud_provider//Visibility for the Cloud Provider
  • Deletesummary_by_cloudprovider.count_by_regions//Threats Count by region
  • POST/security/executive_dashboard/threats/trend_by_severity Get Threats by Trend

📘

Parameter

  • Add SecurityDashboardRequest
  • DeleteSecurityDashboardByTrendRequest

📘

Return Type

  • Deletesummary_by_month.count_by_severity.high//Threats High Total Count
  • Deletesummary_by_month.count_by_severity.medium//Threats Medium Total Count
  • Deletesummary_by_month.count_by_severity.low//Threats Low Total Count
  • POST/security/executive_dashboard/vulnerabilities/by_cloud_account Get Vulnerability by Cloud Account

📘

Parameter

  • Add SecurityDashboardRequest
  • DeleteSecurityDashboardByTrendRequest

📘

Return Type

  • Change summary_by_accounts.count_by_severity.critical
  • Change summary_by_accounts.count_by_severity.high
  • Change summary_by_accounts.count_by_severity.medium
  • Change summary_by_accounts.count_by_severity.low
  • Change summary_by_accounts.count_by_severity.none
  • POST/security/executive_dashboard/vulnerabilities/by_region Get Vulnerability by Region

📘

Parameter

  • Add SecurityDashboardRequest
  • DeleteSecurityDashboardByTrendRequest
  • POST/security/executive_dashboard/vulnerabilities/trend_by_severity Get Vulnerability by Trend

📘

Parameter

  • Add SecurityDashboardRequest
  • DeleteSecurityDashboardByTrendRequest

📘

Return Type

  • Change summary_by_month.count_by_severity.critical
  • Change summary_by_month.count_by_severity.high
  • Change summary_by_month.count_by_severity.medium
  • Change summary_by_month.count_by_severity.low
  • Change summary_by_month.count_by_severity.none
  • POST/self_service/resource_catalogs/{tenant_id}/create Create Resource Catalog

📘

Parameter

  • Add ResourceCatalogServiceLevelDataModel
  • DeleteResourceCatalogservicelevelDataModel
  • PUT/self_service/resource_catalogs/{tenant_id}/{catalog_id} Update Resource Catalog

📘

Parameter

  • Add ResourceCatalogServiceLevelDataModel
  • DeleteResourceCatalogservicelevelDataModel
  • POST/usergroups/create Create Usergroup

📘

Parameter

  • Add UserGroupCreateRequest.tenant_ids//List of tenant IDs within the corestack account
  • DeleteUserGroupCreateRequest.tenant_id//ID of the tenant within the CoreStack account
  • Change UserGroupCreateRequest.roles
  • Change UserGroupCreateRequest.users
  • Change UserGroupCreateRequest.scope
  • GET/users/filter-options List Users

📘

Return Type

Change tenants.cloud_providers.cloud_accounts.currency (Added Enum)

  • GET/users/list List Users

📘

Return Type

  • Deleteusers.user_id//ID of the User. This is an auto generated and unique in the CoreStack system
  • Deleteusers.username//Username is unique in the CoreStack system. User can use this to login to CoreStack portal in addition to email
  • Deleteusers.status//Current Status of the user - active or inactive. Inactive user cannot login or use AccessKeys
  • Deleteusers.email//Email of the User. This is unique in the CoreStack system
  • Deleteusers.role_assignment//List of roles assignments or the user. The same user can be assigned different roles in different tenants
  • Deleteusers.timezone_id//Id of the Timezone such as Asia/Kolkata, Asia/Dubai and so on
  • GET/users/view/{user_id} Describe User

📘

Return Type

  • Deleterole_assignment.tenant_name//Name of the tenant within the CoreStack account
  • Deleterole_assignment.tenant_id//ID of the tenant within the CoreStack account
  • Deleterole_assignment.roles//List of roles for this tenant. User can have multiple roles within a tenant
  • POST/users/{user_id}/activate_user/{auth_token} Activate User

📘

Return Type

  • Add user_id//User ID
  • Deletefirst_name//first name
  • Deletelast_name//last name
  • Deletemobile//mobile
  • POST/v1/executive_dashboard_version/create Create new Dashboard Definition Version

📘

Parameter

Add DashboardDefinitionVersion.details.description

📘

Return Type

Add details.description

  • POST/v1/executive_dashboard_version/parseImport Parse Dashboard Definition Version

📘

Return Type

Add description

  • 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.resource_categories//Resource categories to filter (all if missing)
  • Add TagPostureSummaryListRequest.filters.resource_components//Resource components to filter (all if missing)
  • Add TagPostureSummaryListRequest.filters.resource_types//Resources types to filter (all if missing)
  • Add TagPostureSummaryListRequest.filters.supports_remediation_only//Whether to only return resources that support remediation
  • Change TagPostureSummaryListRequest.sort.column (Added Enum)
  • 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.resource_categories//Resource categories to filter (all if missing)
  • Add TagPostureSummaryListRequest.filters.resource_components//Resource components to filter (all if missing)
  • Add TagPostureSummaryListRequest.filters.resource_types//Resources types to filter (all if missing)
  • Add TagPostureSummaryListRequest.filters.supports_remediation_only//Whether to only return resources that support remediation
  • Change TagPostureSummaryListRequest.sort.column (Added Enum)
  • PUT/{tenant_id}/budgets/threshold_alerts/update Update Budget Threshold Alerts

📘

Parameter

  • Add ThresholdAlertUpdateReqModel.threshold_details.id//Threshold alert id which can be retrieved from View Budget Threshold Alerts API
  • DeleteThresholdAlertUpdateReqModel.threshold_details._id//Threshold alert id
  • POST/{tenant_id}/budgets/threshold_alerts/view View Budget Threshold Alerts

📘

Return Type

Add threshold_details.id//threshold id