openapi: 3.2.0 info: title: CoreStack External Cost API version: 1.0.0 termsOfService: http://corestack.io/ license: name: CoreStack Inc License url: http://corestack.io/licenses/LICENSE-2.0.html description: Cost Pillar servers: - url: / tags: - name: Cost description: Cost Pillar paths: /cost/cost_savings/accounts/visibility/{tenant_id}: put: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListRecommendationsResponse' summary: List Cost Saving Recommendation description: list recommendation operationId: CostSavingListRecommendation parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/ListRecommendationsRequest' required: true /cost/cost_savings/accounts/visibility/{tenant_id}/recommendations/{recommendation_id}/view: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListRecommendationsViewResponse' summary: View Cost Saving Recommendation description: view recommendation operationId: CostSavingViewRecommendation parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string - name: recommendation_id in: path required: true description: Recommendation Id.Can be fetched from '/cost/cost_savings/accounts/visibility/{tenant_id}' or '/cost/cost_savings/tenants/visibility/{tenant_id}' api schema: type: string security: - auth_token: [] tags: - Cost /cost/cost_savings/cost_saved_recommendation: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CostSavingsRecommendationsResponse' summary: List Cost Saving Recommendations description: view cost saving recommendation operationId: ListCostSavingRecommendations parameters: - description: Currency to fetch the data in: query x-cs-enum-type: Currency required: false name: currency schema: type: string enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR security: - auth_token: [] tags: - Cost /cost/cost_savings/tenants/visibility/{tenant_id}: put: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListRecommendationsTenantResponse' summary: List Cost Saving Recommendation by Tenant description: list recommendation tenant operationId: CostSavingListRecommendationTenant parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/ListRecommendationsTenantRequest' required: true /cost/cost_savings/{tenant_id}/resolve_recommendation/{recommendation_id}: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Resolved content: application/json: schema: type: boolean summary: Resolve Cost Savings Recommendations description: Resolve cost savings recommendation operationId: ResolveCostSavingsRecommendation parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string - name: recommendation_id in: path required: true description: Recommendation Id.Can be fetched from '/cost/cost_savings/accounts/visibility/{tenant_id}' or '/cost/cost_savings/tenants/visibility/{tenant_id}' api schema: type: string security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/ResolveCostSavingsRecommendationsRequest' required: true /cost/costoptimizer/optimizerate/license_benefit/hub_discounts: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/LicenseBenefitHubDiscountsResponse' summary: License Benefit Hub Discounts description: License Benefit operationId: LicenseBenefitHubDiscounts security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/LicenseBenefitHubDiscountsRequest' required: true /cost/costoptimizer/optimizerate/license_benefit/saving_summary: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/LicenseBenefitSavingResponse' summary: License Benefit Cost Savings Summary description: License Benefit operationId: LicenseBenefitSavingSummary security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/LicenseBenefitSavingRequest' required: true /cost/costoptimizer/optimizeusage/tenant: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CostOptimizationTenResponse' summary: Tenant Details description: Under cost optimization Tenant ID and Tenant details operationId: TenantDetails parameters: - description: select the request type in: query required: true name: request_type schema: type: string enum: - right_size - orphaned - idle - config security: - auth_token: [] tags: - Cost /cost/costoptimizer/optimizeusage/{tenant_id}/cloud_account_summary: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CostOptimizationCloudAccountSummaryResponse' summary: Overall Cloud Account Summary description: cost optimization overall cloud account summary operationId: costOptimizationCloudAccountSummary parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string - description: select the request type in: query required: true name: request_type schema: type: string enum: - right_size - orphaned - idle - config security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/CostOptimizationCloudAccountSummaryRequest' required: true /cost/costoptimizer/optimizeusage/{tenant_id}/cloud_account_type: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CostOptimizationCloudAccTypeResponse' summary: Cloud Account Details description: fetch cloud account details operationId: CostOptimizationCloudAccountType parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string - description: select the request type in: query required: true name: request_type schema: type: string enum: - right_size - orphaned - idle - config security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/CostOptimizationCloudAccountTypeRequest' required: true /cost/costoptimizer/optimizeusage/{tenant_id}/cloud_accounts: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CloudAccounts' summary: View Cloud Account_ID and Cloud Account Name description: fetch cloud account_id and cloud account name operationId: CostOptimizationCloudAccounts parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string - description: select mode of currency in: query x-cs-enum-type: Currency required: true name: currency schema: type: string enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR - description: select cloud account type in: query x-cs-enum-type: CloudServiceName required: true name: service_name schema: type: string enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter default: AWS - description: select the request type in: query required: true name: request_type schema: type: string enum: - right_size - orphaned - idle - config security: - auth_token: [] tags: - Cost /cost/costoptimizer/optimizeusage/{tenant_id}/filter: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FilterServices' summary: View Tenant Wise Currency's Or Cloud Account Type description: view tenant wise currency or cloud account type operationId: TenantServicesFilter parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string - description: view cloud account type in: query required: false name: services schema: type: string enum: - 'true' - 'false' - description: view currency in: query required: false name: currency schema: type: string enum: - 'true' - 'false' - description: select the cloud type in: query x-cs-enum-type: CloudServiceName required: false name: service_name schema: type: string enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter default: AWS - description: select the request type in: query required: true name: request_type schema: type: string enum: - right_size - orphaned - idle - config security: - auth_token: [] tags: - Cost /cost/costoptimizer/optimizeusage/{tenant_id}/summary: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/OptimizationSummary' summary: Tenant Wise Cost Summary description: under cost optimization tenant wise summary operationId: TenantCostSummary parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string - description: select the cloud account type in: query x-cs-enum-type: CloudServiceName required: false name: service_name schema: type: string enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter default: AWS - description: select the mode of currency in: query x-cs-enum-type: Currency required: true name: currency schema: type: string enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR - description: select the request type in: query required: true name: request_type schema: type: string enum: - right_size - orphaned - idle - config security: - auth_token: [] tags: - Cost /cost/costoptimizer/optimizeusage/{tenant_id}/top_recommendations: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TopRecommendations' summary: View Resource Wise Cost Details Under Cloud Account ID description: Fetch Cost Optimization Top Recommendation as per resource IDs operationId: CostOptimizationTopRecommendations parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string - description: provide recommendation_id name: recommendation_id in: query schema: type: string - description: provide resource_id name: resource_id in: query schema: type: string - description: provide cloud_account_id name: cloud_account_id in: query schema: type: string - description: select mode of currency name: currency in: query schema: type: string - description: provide resource_type name: resource_type in: query schema: type: string security: - auth_token: [] tags: - Cost /cost/costoptimizer/optimizeusage/{tenant_id}/view_recommendations: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CostOptimizationViewRecommendationResponse' summary: Resource Wise Recommendation(Savings) Data description: Cost Optimization Resource wise Recommendation(saving) data operationId: CostOptimizationViewRecommendations parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string - description: resource status in: query required: false name: resource_status schema: type: string enum: - open - close - description: select the request type in: query required: true name: request_type schema: type: string enum: - right_size - orphaned - idle - config security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/CostOptimizationViewRecommendationRequest' required: true /cost/executive_dashboard/budget_drift: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/BudgetDrift' summary: Get Actual or Forecast Budget Drift description: View Current or Forecast budget drift. operationId: BudgetDrift security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/BudgetDriftRequest' required: true /cost/executive_dashboard/cost_anomalies_by_cloud: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/CostAnomalyByCloud' summary: Get Cost Spend By Cloud and Resource Category description: View Cost Anomalies By Cloud. operationId: CostAnomaliesByCloud security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/CostAnomalyByCloudRequest' required: true /cost/executive_dashboard/cost_optimization_by_optimization_types: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/CostOptimizationByOptimizationTypes' summary: cost optimization by optimization type description: View Cost Optimization By Optimization Types. operationId: CostOptimizationByOptimizationTypes security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/CostOptimizationByOptimizationTypesRequest' required: true /cost/executive_dashboard/cost_optimization_trend: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/CostOptimizationTrend' summary: Get cost optimization trend description: View cost optimization trend. operationId: GetCostOptimizationTrend security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/CostOptimizationTrendRequest' required: true /cost/executive_dashboard/geo_coordinates_for_regions: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/GeoCoordinatesForRegion' summary: geo coordinates for regions description: View Geo Coordinates For Regions. operationId: GeoCoordinatesForRegions security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/GeoCoordinatesForRegionRequest' required: true /cost/executive_dashboard/tagged_and_untagged_resources: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/TaggedUntaggedResourcesByProductCategory' summary: Get Tagged and Untagged Resources Cost By Product Category description: View Tagged and Untagged Resources By Product Category. operationId: TaggedUntaggedResources security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/TaggedUntaggedResourcesByProductCategoryRequest' required: true /cost/executive_dashboard/top_budgets: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/TopBudgetByTenant' summary: Get Top Budget By Tenant description: View Top Budget By Tenant. operationId: TopBudgetByTenant security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/TopBudgetByTenantRequest' required: true /cost/markups_and_discounts/{tenant_id}/create: put: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateMarkupResponse' summary: Create Cost Markup Rule description: create Markup rule operationId: CreateMarkupRule parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMarkupRequest' required: true /cost/markups_and_discounts/{tenant_id}/delete: delete: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteMarkupResponse' summary: Delete Cost Markup Rule description: delete Markup rule operationId: DeleteMarkupRule parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string - description: Specify the rule name to be deleted in: query required: true name: rule_name schema: type: string security: - auth_token: [] tags: - Cost /cost/markups_and_discounts/{tenant_id}/list: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/MarkupDetails' summary: List Cost Markup Rules description: list Markup rules operationId: ListMarkupRules parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string - description: Specify the action to fetch markup data in: query required: true name: action schema: type: string enum: - list_configured_rules - description: Specify the scope to fetch markup data in: query name: scope schema: type: string enum: - tenant - cloud_account security: - auth_token: [] tags: - Cost /cost/markups_and_discounts/{tenant_id}/update: put: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateMarkupResponse' summary: Update Cost Markup Rule description: update Markup rule operationId: UpdateMarkupRule parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMarkupRequest' required: true /cost/ri/recommendation: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListRIRecommendationsResponse' summary: List Recommendations description: View RI Recommendations Reservations operationId: RIRecommendationsReservations security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/ListRIRecommendationsRequest' required: true /cost/ri/utilization/reservations: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListReservationsResponse' summary: List Cost Reservations & Utilization description: list reservation utilization operationId: ListReservationsUtilization parameters: - description: Date Filter to select in: query x-cs-enum-type: DashboardDateFilter required: true name: date_filter schema: type: string enum: - current_month - current_month_minus_1 - current_month_minus_2 - current_month_minus_3 - current_month_minus_4 - current_month_minus_5 - current_month_minus_6 - current_month_minus_7 - current_month_minus_8 - current_month_minus_9 - current_month_minus_10 - current_month_minus_11 - current_month_minus_12 - description: Currency to fetch the data in: query x-cs-enum-type: Currency required: true name: currency schema: type: string enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR - description: cloud service name in: query x-cs-enum-type: CloudServiceName required: false name: service schema: type: string enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter default: AWS security: - auth_token: [] tags: - Cost post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListReservationsResponse' summary: List Cost Reservations & Utilization (multi-tenant) description: list reservation utilization across one or more tenants in a single call operationId: ListReservationsUtilizationV2 security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/ListReservationsV2Request' required: true /cost/ri/utilization/{cloud_account_id}/reservations/{reservation_id}: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListReservationsServiceAccountResponse' summary: List Cost Reservations & Utilization by Cloud Account description: list reservation utilization cloud account wise operationId: ListReservationsUtilizationCloudAccount parameters: - name: cloud_account_id in: path required: true description: Specify the Cloud Account ID. This can be fetched from List CloudAccounts API call. schema: type: string - name: reservation_id in: path required: true description: Specify the Reservation ID for the Cloud Account. This can be fetched from List Cost Reservations & Utilizations API call. schema: type: string - description: Date Filter to select in: query x-cs-enum-type: DashboardDateFilter required: true name: date_filter schema: type: string enum: - current_month - current_month_minus_1 - current_month_minus_2 - current_month_minus_3 - current_month_minus_4 - current_month_minus_5 - current_month_minus_6 - current_month_minus_7 - current_month_minus_8 - current_month_minus_9 - current_month_minus_10 - current_month_minus_11 - current_month_minus_12 security: - auth_token: [] tags: - Cost /v1/cost/costoptimizer/optimizerate/long_term_savings/recommended_reservations/savings_summary: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RecommendedReservationsSavingsSummaryResponse' summary: Saving Summary for Recommended Reservations description: Recommended Reservations Savings Summary operationId: RecommendedReservationsSavingsSummary security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/RecommendedReservationsSavingsSummaryRequest' required: true /v1/cost/finops_assessment_trigger/{tenant_id}/{cloud_account_id}: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FinopsAssessmentTriggerResponse' summary: Finops Assessment Trigger description: Trigger FinOps Assessment operationId: FinopsAssessmentTrigger parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string - name: cloud_account_id in: path required: true description: Specify the cloud account ID. This is a unique ID and can be retrieved using the List cloud account API. schema: type: string security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/FinopsAssessmentTriggerRequest' required: true /v1/cost/finops_assessment_trigger_history/{cloud_account_id}: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/FinopsAssessmentHistory' summary: Finops Assessment Trigger History description: History of Triggered FinOps Assessment in Desc order operationId: FinopsAssessmentTriggerHistory parameters: - name: cloud_account_id in: path required: true description: Specify the cloud account ID. This is a unique ID and can be retrieved using the List cloud account API. schema: type: string security: - auth_token: [] tags: - Cost /v1/cost/finops_assessment_trigger_status/{assessment_run_id}: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FinopsAssessmentTriggerStatusResponse' summary: Finops Assessment Trigger Status description: Status of Triggered FinOps Assessment operationId: FinopsAssessmentTriggerStatus parameters: - name: assessment_run_id in: path required: true description: Specify the assessment run ID. This is a unique ID and can be retrieved using the Finops Assessment Trigger API. schema: type: string security: - auth_token: [] tags: - Cost /v1/cost/tags/batch: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Generated content: application/json: schema: $ref: '#/components/schemas/CostTagBatchResponse' summary: Returns a batch of CostTag description: Batch Tags operationId: CostTagBatch security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchRequest' required: true /v1/cost/tags/list: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Generated content: application/json: schema: $ref: '#/components/schemas/ListResponse' summary: Returns a list of CostTag ids description: List Tags operationId: CostTagList security: - auth_token: [] tags: - Cost requestBody: content: application/json: schema: $ref: '#/components/schemas/CostTagListRequest' required: true components: schemas: LicenseBenefitSavingResponse: properties: recommendations_count: type: integer description: Recommendations Count impacted_resource_count: type: integer description: Impacted Resource Count potential_cost_saving: type: string description: Potential Cost Saving savings_percentage: type: number description: Savings Percentage info: type: string description: Potential Savings % compared to the Forecasted Spend type: object Budget: properties: budget_period: type: string budget_amount: type: number type: object CostOptimizationViewRecommendationRequest: required: - cloud_account_id - currency properties: page: type: integer description: 'page number.Example ''page'': 1' limit: type: integer description: 'records limits.Example ''limit'': 10' cloud_account_id: type: string description: Cloud account id currency: type: string description: currency type type: object CostOptimizationTenResponse: required: - message - status - tenant properties: status: type: string description: Response status on tenant details message: type: string description: Listing tenants data retrieved successfully tenant: type: object description: tenant details type: object LicenseBenefitHubDiscountsRequest: required: - currency - limit - page properties: page: type: integer description: page number.Example 'page':'1' limit: type: integer description: records limits.Example 'limit':'10' currency: type: string description: currency of the cost. Example 'currency':'USD' example: AED enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR x-cs-enum-type: Currency cloud_provider: type: string description: Cloud Provider for the cloud account example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName type: object FilterValue: required: - cloud_account - payment_option - region - reservation_sku - reservation_type - tenant properties: reservation_sku: type: array description: Reservation SKU Details items: type: string payment_option: type: array description: Available payment option items: type: string region: type: array description: Region available items: type: string reservation_type: type: array description: Reservation Type items: type: string cloud_account: type: array description: Cloud Account Details items: $ref: '#/components/schemas/RangeValue' tenant: type: array description: Tenant name items: type: string type: object RecommendedReservationsSavingsSummaryResponse: properties: recommendations_count: type: integer description: Recommendations Count. potential_cost_saving: type: number description: Potential Cost Saving. total_reservations: type: integer description: Total reservations. potential_current_estimated_cost: type: number description: Potential current estimated cost. type: object RecommendationView: required: - current_sku - estimated_cost - estimated_cost_saving - estimated_cost_saving_info - impact_level - optimization_type - recommendation_id - recommended_sku - region - resource_id - resource_name - resource_recommendation_id - resource_type - savings_percentage - status - summary properties: resource_recommendation_id: type: string description: Identifier for resource recommendation recommendation_id: type: string description: Recommendation id resource_name: type: string description: Resource name resource_type: type: string description: Resource type resource_id: type: string description: Resource id status: type: string description: Status summary: type: string description: Summary impact_level: type: string description: Impact level estimated_cost: type: number description: Estimated cost region: type: string description: Region estimated_cost_saving: type: number description: Estimated cost saving optimization_type: type: string description: Optimization type recommended_sku: type: string description: Recommended SKU current_sku: type: string description: Current SKU savings_percentage: type: string description: Savings percentage estimated_cost_saving_info: type: string description: Estimated cost saving information type: object CostWiseSummary: required: - AWS - Azure - GCP - total_cost properties: total_cost: type: number description: Total cost saved Azure: type: number description: Cost saved for Azure based on recommendation AWS: type: number description: Cost saved for AWS based on recommendation GCP: type: number description: Cost saved for GCP based on recommendation type: object FilterServices: required: - cloud account type - currency properties: cloud account type: type: array description: cloud account type items: type: object currency: type: array description: currency types items: type: object type: object QueryOperator: required: - __type properties: {} discriminator: propertyName: __type type: object x-cs-subtypes: - subtype_model: QueryOperatorTrue subtype_name: QueryOperatorTrue - subtype_model: QueryOperatorFalse subtype_name: QueryOperatorFalse - subtype_model: QueryOperatorBinary subtype_name: QueryOperatorBinary - subtype_model: QueryOperatorBinaryLogic subtype_name: QueryOperatorBinaryLogic - subtype_model: QueryOperatorNary subtype_name: QueryOperatorNary - subtype_model: QueryOperatorNaryLogic subtype_name: QueryOperatorNaryLogic - subtype_model: QueryOperatorComparator subtype_name: QueryOperatorComparator - subtype_model: QueryOperatorComparatorLogic subtype_name: QueryOperatorComparatorLogic - subtype_model: QueryOperatorUnary subtype_name: QueryOperatorUnary - subtype_model: QueryOperatorUnaryNot subtype_name: QueryOperatorUnaryNot - subtype_model: QueryOperatorBinaryForGraph subtype_name: QueryOperatorBinaryForGraph - subtype_model: QueryOperatorBinaryLogicForGraph subtype_name: QueryOperatorBinaryLogicForGraph - subtype_model: QueryOperatorNaryForGraph subtype_name: QueryOperatorNaryForGraph - subtype_model: QueryOperatorNaryLogicForGraph subtype_name: QueryOperatorNaryLogicForGraph - subtype_model: QueryOperatorUnaryForGraph subtype_name: QueryOperatorUnaryForGraph - subtype_model: QueryOperatorUnaryNotForGraph subtype_name: QueryOperatorUnaryNotForGraph - subtype_model: ServiceAccountQueryOperator subtype_name: ServiceAccountQueryOperator - subtype_model: TenantQueryOperator subtype_name: TenantQueryOperator - subtype_model: DescendantServiceAccountQueryOperator subtype_name: DescendantServiceAccountQueryOperator - subtype_model: DescendantServiceAccountInTenantQueryOperator subtype_name: DescendantServiceAccountInTenantQueryOperator - subtype_model: TenantTagKeyQueryOperator subtype_name: TenantTagKeyQueryOperator - subtype_model: TenantTagKeyValueQueryOperator subtype_name: TenantTagKeyValueQueryOperator - subtype_model: LocationQueryOperator subtype_name: LocationQueryOperator - subtype_model: AvailabilityZoneQueryOperator subtype_name: AvailabilityZoneQueryOperator - subtype_model: BillingSourceQueryOperator subtype_name: BillingSourceQueryOperator - subtype_model: CurrencyQueryOperator subtype_name: CurrencyQueryOperator - subtype_model: ProductCategoryQueryOperator subtype_name: ProductCategoryQueryOperator - subtype_model: ProductFamilyQueryOperator subtype_name: ProductFamilyQueryOperator - subtype_model: ProductServiceCodeQueryOperator subtype_name: ProductServiceCodeQueryOperator - subtype_model: ProductSkuQueryOperator subtype_name: ProductSkuQueryOperator - subtype_model: PublisherQueryOperator subtype_name: PublisherQueryOperator - subtype_model: ResourceCategoryQueryOperator subtype_name: ResourceCategoryQueryOperator - subtype_model: ResourceIdQueryOperator subtype_name: ResourceIdQueryOperator - subtype_model: ResourceGroupQueryOperator subtype_name: ResourceGroupQueryOperator - subtype_model: ResourceNameQueryOperator subtype_name: ResourceNameQueryOperator - subtype_model: ResourceOperationQueryOperator subtype_name: ResourceOperationQueryOperator - subtype_model: ResourceQueryExtraPresence subtype_name: ResourceQueryExtraPresence - subtype_model: ResourceQueryExtraKey subtype_name: ResourceQueryExtraKey - subtype_model: ScopeContainsTenantQueryOperator subtype_name: ScopeContainsTenantQueryOperator - subtype_model: ScopeContainsServiceAccountQueryOperator subtype_name: ScopeContainsServiceAccountQueryOperator - subtype_model: ScopeIsQueryOperator subtype_name: ScopeIsQueryOperator - subtype_model: ServiceCategoryQueryOperator subtype_name: ServiceCategoryQueryOperator - subtype_model: ServiceTypeQueryOperator subtype_name: ServiceTypeQueryOperator - subtype_model: CompartmentNameQueryOperator subtype_name: CompartmentNameQueryOperator - subtype_model: ResourceQueryExtraKeyValue subtype_name: ResourceQueryExtraKeyValue - subtype_model: WorkFlowIdQueryOperator subtype_name: WorkFlowIdQueryOperator - subtype_model: RecommendationSubClassificationQueryOperator subtype_name: RecommendationSubClassificationQueryOperator - subtype_model: ServiceNowCmdbQuerySyncLogResourceId subtype_name: ServiceNowCmdbQuerySyncLogResourceId - subtype_model: ServiceNowCmdbQuerySyncLogResourceType subtype_name: ServiceNowCmdbQuerySyncLogResourceType - subtype_model: ServiceNowCmdbQuerySyncLogAction subtype_name: ServiceNowCmdbQuerySyncLogAction - subtype_model: ServiceNowCmdbQuerySyncLogStatus subtype_name: ServiceNowCmdbQuerySyncLogStatus - subtype_model: ServiceNowCmdbQuerySyncLogService subtype_name: ServiceNowCmdbQuerySyncLogService - subtype_model: ServiceAccountNativeDetailsQueryOperator subtype_name: ServiceAccountNativeDetailsQueryOperator - subtype_model: ServiceAccountStatusQueryOperator subtype_name: ServiceAccountStatusQueryOperator - subtype_model: ServiceAccountTagKeyQueryOperator subtype_name: ServiceAccountTagKeyQueryOperator - subtype_model: ServiceAccountTagKeyRegexQueryOperator subtype_name: ServiceAccountTagKeyRegexQueryOperator - subtype_model: ServiceAccountTagKeyValueQueryOperator subtype_name: ServiceAccountTagKeyValueQueryOperator - subtype_model: ApplicableHealthMetricsQueryOperator subtype_name: ApplicableHealthMetricsQueryOperator - subtype_model: EpssScoreRangeQueryOperator subtype_name: EpssScoreRangeQueryOperator - subtype_model: CvssMetricScoreRangeQueryOperator subtype_name: CvssMetricScoreRangeQueryOperator - subtype_model: GraphionScoreRangeQueryOperator subtype_name: GraphionScoreRangeQueryOperator - subtype_model: AppSecopsApplicationIdQueryOperator subtype_name: AppSecopsApplicationIdQueryOperator - subtype_model: AppSecopsPortfolioIdQueryOperator subtype_name: AppSecopsPortfolioIdQueryOperator - subtype_model: AppSecopsProjectIdQueryOperator subtype_name: AppSecopsProjectIdQueryOperator - subtype_model: AppSecopsSbomComponentIdQueryOperator subtype_name: AppSecopsSbomComponentIdQueryOperator - subtype_model: AppSecopsSbomVersionIdQueryOperator subtype_name: AppSecopsSbomVersionIdQueryOperator - subtype_model: AppSecopsComponentProductQueryOperator subtype_name: AppSecopsComponentProductQueryOperator - subtype_model: AppSecopsSbomComponentTypeQueryOperator subtype_name: AppSecopsSbomComponentTypeQueryOperator - subtype_model: AppSecopsSbomVersionSubmittedByQueryOperator subtype_name: AppSecopsSbomVersionSubmittedByQueryOperator - subtype_model: AppSecopsSbomVersionSubmittedDateQueryOperator subtype_name: AppSecopsSbomVersionSubmittedDateQueryOperator - subtype_model: AppSecopsSbomVersionBuildIdQueryOperator subtype_name: AppSecopsSbomVersionBuildIdQueryOperator - subtype_model: AppSecopsSbomNameQueryOperator subtype_name: AppSecopsSbomNameQueryOperator - subtype_model: AppSecopsCveIdQueryOperator subtype_name: AppSecopsCveIdQueryOperator - subtype_model: AppSecopsEpssScoreQueryOperator subtype_name: AppSecopsEpssScoreQueryOperator - subtype_model: AppSecopsCvssScoreQueryOperator subtype_name: AppSecopsCvssScoreQueryOperator - subtype_model: AppSecopsGraphionScoreQueryOperator subtype_name: AppSecopsGraphionScoreQueryOperator - subtype_model: SecopsVulnerabilitySeverityQueryOperator subtype_name: SecopsVulnerabilitySeverityQueryOperator - subtype_model: AppSecopsIsKnownExploitedVulnerabilityQueryOperator subtype_name: AppSecopsIsKnownExploitedVulnerabilityQueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricAttackVectorV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricAttackVectorV31QueryOperator - subtype_model: AppSecopsFixAvailableQueryOperator subtype_name: AppSecopsFixAvailableQueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricAttackComplexityV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricAttackComplexityV31QueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricPrivilegesRequiredV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricPrivilegesRequiredV31QueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricScopeV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricScopeV31QueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityUserInteractionV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityUserInteractionV31QueryOperator - subtype_model: AppSecopsVulnerabilityImpactMetricConfidentialityImpactV31QueryOperator subtype_name: AppSecopsVulnerabilityImpactMetricConfidentialityImpactV31QueryOperator - subtype_model: AppSecopsVulnerabilityImpactMetricIntegrityImpactV31QueryOperator subtype_name: AppSecopsVulnerabilityImpactMetricIntegrityImpactV31QueryOperator - subtype_model: AppSecopsVulnerabilityImpactMetricAvailabilityImpactV31QueryOperator subtype_name: AppSecopsVulnerabilityImpactMetricAvailabilityImpactV31QueryOperator - subtype_model: AppSecopsContainerFindingsSBOMVersionIdsQueryOperator subtype_name: AppSecopsContainerFindingsSBOMVersionIdsQueryOperator - subtype_model: AppSecopsContainerFindingsCategoryQueryOperator subtype_name: AppSecopsContainerFindingsCategoryQueryOperator - subtype_model: AppSecopsContainerFindingsExecutionPhaseQueryOperator subtype_name: AppSecopsContainerFindingsExecutionPhaseQueryOperator - subtype_model: AppSecopsContainerFindingsSeverityQueryOperator subtype_name: AppSecopsContainerFindingsSeverityQueryOperator - subtype_model: AppSecopsContainerFindingsStatusQueryOperator subtype_name: AppSecopsContainerFindingsStatusQueryOperator - subtype_model: DimensionSourceQueryOperator subtype_name: DimensionSourceQueryOperator - subtype_model: DimensionQueryOperator subtype_name: DimensionQueryOperator - subtype_model: ResourceTypeQueryOperator subtype_name: ResourceTypeQueryOperator - subtype_model: PodIdRegexQueryOperator subtype_name: PodIdRegexQueryOperator - subtype_model: PodNameRegexQueryOperator subtype_name: PodNameRegexQueryOperator - subtype_model: ContainerIdRegexQueryOperator subtype_name: ContainerIdRegexQueryOperator - subtype_model: PodNamesQueryOperator subtype_name: PodNamesQueryOperator - subtype_model: PodIdsQueryOperator subtype_name: PodIdsQueryOperator - subtype_model: UtilizationTypeQueryOperator subtype_name: UtilizationTypeQueryOperator - subtype_model: ResourceIdRegexQueryOperator subtype_name: ResourceIdRegexQueryOperator - subtype_model: ResourceNameRegexQueryOperator subtype_name: ResourceNameRegexQueryOperator - subtype_model: ExtrasValueRegexQueryOperator subtype_name: ExtrasValueRegexQueryOperator - subtype_model: TagKeyValueRegexQueryOperator subtype_name: TagKeyValueRegexQueryOperator - subtype_model: ResourceQueryTagKeyKind subtype_name: ResourceQueryTagKeyKind - subtype_model: ResourceQueryTagKeyValuesKind subtype_name: ResourceQueryTagKeyValuesKind - subtype_model: TagKeyStringValueRegexQueryOperator subtype_name: TagKeyStringValueRegexQueryOperator - subtype_model: TagKindStringKeyRegexQueryOperator subtype_name: TagKindStringKeyRegexQueryOperator - subtype_model: ServiceAccountNameRegexQueryOperator subtype_name: ServiceAccountNameRegexQueryOperator - subtype_model: TenantNameRegexQueryOperator subtype_name: TenantNameRegexQueryOperator - subtype_model: PlatFormAccountQueryOperator subtype_name: PlatFormAccountQueryOperator - subtype_model: BillingLineItemTypeQueryOperator subtype_name: BillingLineItemTypeQueryOperator - subtype_model: BillingEntityQueryOperator subtype_name: BillingEntityQueryOperator - subtype_model: LineItemDescriptionQueryOperator subtype_name: LineItemDescriptionQueryOperator - subtype_model: LineItemDescriptionRegexQueryOperator subtype_name: LineItemDescriptionRegexQueryOperator - subtype_model: MeterSubCategoryQueryOperator subtype_name: MeterSubCategoryQueryOperator - subtype_model: PricingCategoryQueryOperator subtype_name: PricingCategoryQueryOperator - subtype_model: PricingPurchaseOptionQueryOperator subtype_name: PricingPurchaseOptionQueryOperator - subtype_model: TagKeyRegexQueryOperator subtype_name: TagKeyRegexQueryOperator - subtype_model: BillingLineItemTypeRegexQueryOperator subtype_name: BillingLineItemTypeRegexQueryOperator - subtype_model: ResourceGroupRegexQueryOperator subtype_name: ResourceGroupRegexQueryOperator - subtype_model: ResourceCategoryRegexQueryOperator subtype_name: ResourceCategoryRegexQueryOperator - subtype_model: ProductCategoryRegexQueryOperator subtype_name: ProductCategoryRegexQueryOperator - subtype_model: BillingEntityRegexQueryOperator subtype_name: BillingEntityRegexQueryOperator - subtype_model: ResourceOperationRegexQueryOperator subtype_name: ResourceOperationRegexQueryOperator - subtype_model: ResourceQueryFieldPresence subtype_name: ResourceQueryFieldPresence - subtype_model: AssessmentRunReportDetailQuerySection subtype_name: AssessmentRunReportDetailQuerySection - subtype_model: AssessmentRunReportSummaryQuerySection subtype_name: AssessmentRunReportSummaryQuerySection - subtype_model: AssessmentQueryAssessmentName subtype_name: AssessmentQueryAssessmentName - subtype_model: AssessmentQueryAssessmentOwner subtype_name: AssessmentQueryAssessmentOwner - subtype_model: AssessmentQueryAssessmentApprover subtype_name: AssessmentQueryAssessmentApprover - subtype_model: AssessmentQueryWorkload subtype_name: AssessmentQueryWorkload - subtype_model: AssessmentQueryFramework subtype_name: AssessmentQueryFramework - subtype_model: AssessmentQueryPillar subtype_name: AssessmentQueryPillar - subtype_model: AssessmentViewQueryNature subtype_name: AssessmentViewQueryNature - subtype_model: AssessmentViewQueryQuestionRisk subtype_name: AssessmentViewQueryQuestionRisk - subtype_model: AssessmentViewQueryBestPracticeRisk subtype_name: AssessmentViewQueryBestPracticeRisk - subtype_model: AssessmentViewQueryQuestionStatus subtype_name: AssessmentViewQueryQuestionStatus - subtype_model: AssessmentViewQueryBestPracticeStatus subtype_name: AssessmentViewQueryBestPracticeStatus - subtype_model: AssessmentViewQueryOwner subtype_name: AssessmentViewQueryOwner - subtype_model: AssessmentViewQueryAssignedTo subtype_name: AssessmentViewQueryAssignedTo - subtype_model: AssessmentViewQueryComment subtype_name: AssessmentViewQueryComment - subtype_model: AssessmentReportQueryAssessmentName subtype_name: AssessmentReportQueryAssessmentName - subtype_model: AssessmentReportQueryFramework subtype_name: AssessmentReportQueryFramework - subtype_model: AssessmentReportQueryReportType subtype_name: AssessmentReportQueryReportType - subtype_model: AssessmentReportQueryWorkloadId subtype_name: AssessmentReportQueryWorkloadId - subtype_model: ScheduleQueryName subtype_name: ScheduleQueryName - subtype_model: ScheduleQueryCreatedBy subtype_name: ScheduleQueryCreatedBy - subtype_model: ScheduleQueryEmailRecipients subtype_name: ScheduleQueryEmailRecipients - subtype_model: ScheduleQueryRecurrence subtype_name: ScheduleQueryRecurrence - subtype_model: ScheduleQueryReportType subtype_name: ScheduleQueryReportType - subtype_model: ScheduleQueryNextGenReportType subtype_name: ScheduleQueryNextGenReportType - subtype_model: ScheduleQueryAssessmentAgentReportType subtype_name: ScheduleQueryAssessmentAgentReportType - subtype_model: AutomationTemplateQueryEngineType subtype_name: AutomationTemplateQueryEngineType - subtype_model: AutomationTemplateQueryRepoType subtype_name: AutomationTemplateQueryRepoType - subtype_model: AutomationTemplateQueryService subtype_name: AutomationTemplateQueryService - subtype_model: AutomationTemplateQueryTenant subtype_name: AutomationTemplateQueryTenant - subtype_model: AwsSecurityHubFindingQueryLocation subtype_name: AwsSecurityHubFindingQueryLocation - subtype_model: AwsSecurityHubFindingQuerySeverity subtype_name: AwsSecurityHubFindingQuerySeverity - subtype_model: AwsSecurityHubFindingQueryProductName subtype_name: AwsSecurityHubFindingQueryProductName - subtype_model: AwsSecurityHubFindingQueryResource subtype_name: AwsSecurityHubFindingQueryResource - subtype_model: AwsSecurityHubFindingQueryCloudAccount subtype_name: AwsSecurityHubFindingQueryCloudAccount - subtype_model: AwsSecurityHubFindingQueryRecordState subtype_name: AwsSecurityHubFindingQueryRecordState - subtype_model: AwsSsmDocumentQueryCloudAccount subtype_name: AwsSsmDocumentQueryCloudAccount - subtype_model: AwsSsmDocumentQueryRegion subtype_name: AwsSsmDocumentQueryRegion - subtype_model: AwsSsmDocumentQueryOwner subtype_name: AwsSsmDocumentQueryOwner - subtype_model: AwsSsmDocumentQueryCategory subtype_name: AwsSsmDocumentQueryCategory - subtype_model: AwsSsmDocumentQueryStatus subtype_name: AwsSsmDocumentQueryStatus - subtype_model: AwsSsmDocumentQueryName subtype_name: AwsSsmDocumentQueryName - subtype_model: AwsSsmDocumentQueryExecutedBy subtype_name: AwsSsmDocumentQueryExecutedBy - subtype_model: ComplianceURIQueryOperator subtype_name: ComplianceURIQueryOperator - subtype_model: DurationInMonthsQueryOperator subtype_name: DurationInMonthsQueryOperator - subtype_model: UniqueIdQueryOperator subtype_name: UniqueIdQueryOperator - subtype_model: ThreatVulnerabilityStatusQueryOperator subtype_name: ThreatVulnerabilityStatusQueryOperator - subtype_model: ThreatVulnerabilitySeverityQueryOperator subtype_name: ThreatVulnerabilitySeverityQueryOperator - subtype_model: ThreatVulnerabilityIssueTypeQueryOperator subtype_name: ThreatVulnerabilityIssueTypeQueryOperator - subtype_model: ThreatIntentQueryOperator subtype_name: ThreatIntentQueryOperator - subtype_model: VulnerabilityReferenceIdQueryOperator subtype_name: VulnerabilityReferenceIdQueryOperator - subtype_model: CostAnomalyStatusQueryOperator subtype_name: CostAnomalyStatusQueryOperator - subtype_model: CurrencyExchangeConfigurationQuerySourceCurrency subtype_name: CurrencyExchangeConfigurationQuerySourceCurrency - subtype_model: CurrencyExchangeConfigurationQueryTargetCurrency subtype_name: CurrencyExchangeConfigurationQueryTargetCurrency - subtype_model: CurrencyExchangeConfigurationQueryScope subtype_name: CurrencyExchangeConfigurationQueryScope - subtype_model: MetricValuesOperator subtype_name: MetricValuesOperator - subtype_model: PatchReadinessStatusQueryOperator subtype_name: PatchReadinessStatusQueryOperator - subtype_model: MasterAccountBillingQueryMasterAccounts subtype_name: MasterAccountBillingQueryMasterAccounts - subtype_model: MasterAccountBillingQueryTenants subtype_name: MasterAccountBillingQueryTenants - subtype_model: MasterAccountBillingQueryUsers subtype_name: MasterAccountBillingQueryUsers - subtype_model: MasterAccountBillingQueryConversations subtype_name: MasterAccountBillingQueryConversations - subtype_model: MasterAccountBillingQueryTransactionType subtype_name: MasterAccountBillingQueryTransactionType - subtype_model: PolicyResourceRecommendationStatusQueryOperator subtype_name: PolicyResourceRecommendationStatusQueryOperator - subtype_model: PolicyResourceRecommendationPolicyIdsQueryOperator subtype_name: PolicyResourceRecommendationPolicyIdsQueryOperator - subtype_model: PolicyResourceRecommendationSeverityQueryOperator subtype_name: PolicyResourceRecommendationSeverityQueryOperator - subtype_model: PolicyRecommendationClassificationQueryOperator subtype_name: PolicyRecommendationClassificationQueryOperator - subtype_model: InfraResourceTrendResourceChangeStatusQueryOperator subtype_name: InfraResourceTrendResourceChangeStatusQueryOperator - subtype_model: VmAgentsQueryOsTypes subtype_name: VmAgentsQueryOsTypes - subtype_model: VmAgentsQueryInstantState subtype_name: VmAgentsQueryInstantState - subtype_model: VmAgentsQueryQualysStatus subtype_name: VmAgentsQueryQualysStatus - subtype_model: VmAgentsQueryCrowdStrikeStatus subtype_name: VmAgentsQueryCrowdStrikeStatus - subtype_model: VmAgentsQuerySplunkStatus subtype_name: VmAgentsQuerySplunkStatus - subtype_model: StacksMarketplaceStackQueryArchived subtype_name: StacksMarketplaceStackQueryArchived - subtype_model: StacksMarketplaceStackQueryAutoApproved subtype_name: StacksMarketplaceStackQueryAutoApproved - subtype_model: StacksMarketplaceStackQueryOwner subtype_name: StacksMarketplaceStackQueryOwner - subtype_model: StacksMarketplaceStackQueryName subtype_name: StacksMarketplaceStackQueryName - subtype_model: StacksMarketplaceStackQueryProduct subtype_name: StacksMarketplaceStackQueryProduct - subtype_model: StacksMarketplaceDeploymentQueryName subtype_name: StacksMarketplaceDeploymentQueryName - subtype_model: StacksMarketplaceDeploymentQueryStack subtype_name: StacksMarketplaceDeploymentQueryStack - subtype_model: StacksMarketplaceDeploymentQueryAccount subtype_name: StacksMarketplaceDeploymentQueryAccount - subtype_model: StacksMarketplaceDeploymentQueryRegion subtype_name: StacksMarketplaceDeploymentQueryRegion - subtype_model: StacksMarketplaceStackDeploymentQueryExecutionStatus subtype_name: StacksMarketplaceStackDeploymentQueryExecutionStatus - subtype_model: MetricNameQueryOperator subtype_name: MetricNameQueryOperator - subtype_model: ResourceQueryCategory subtype_name: ResourceQueryCategory - subtype_model: ResourceQueryLocation subtype_name: ResourceQueryLocation - subtype_model: ResourceQueryResource subtype_name: ResourceQueryResource - subtype_model: ResourceQueryResourceGroup subtype_name: ResourceQueryResourceGroup - subtype_model: ResourceQueryResourceName subtype_name: ResourceQueryResourceName - subtype_model: ResourceQueryResourceType subtype_name: ResourceQueryResourceType - subtype_model: ResourceQueryTagPresence subtype_name: ResourceQueryTagPresence - subtype_model: ResourceQueryTagKey subtype_name: ResourceQueryTagKey - subtype_model: ResourceQueryTagKeyValue subtype_name: ResourceQueryTagKeyValue - subtype_model: WorkloadQueryWorkloadName subtype_name: WorkloadQueryWorkloadName - subtype_model: WorkloadQueryWorkloadOwner subtype_name: WorkloadQueryWorkloadOwner - subtype_model: WorkloadQueryCloud subtype_name: WorkloadQueryCloud - subtype_model: WorkloadQueryCloudAccount subtype_name: WorkloadQueryCloudAccount - subtype_model: WorkloadQueryWorkloadType subtype_name: WorkloadQueryWorkloadType - subtype_model: WorkloadQueryWorkloadId subtype_name: WorkloadQueryWorkloadId TopBudgetByTenant: properties: tenant_id: type: string budget_details: type: array items: $ref: '#/components/schemas/Budget' type: object ListResponse: properties: results: type: array description: List of result identifiers items: type: string next_list_context: description: List context $ref: '#/components/schemas/ListContext' type: object ListReservationsResponse: required: - expiring_in_thirty_days - filters - net_savings - on_demand_cost - page_count - potential_cost_savings_recommended - reservation_cost - reservations - total_count properties: filters: description: Filters available $ref: '#/components/schemas/FilterValue' net_savings: type: integer description: Net savings value expiring_in_thirty_days: type: integer description: How many days are left out for expiry in that month on_demand_cost: type: integer description: On Demand Cost Value reservations: type: array description: Reservation items: $ref: '#/components/schemas/ReservationDetails' page_count: type: integer description: Page Count reservation_cost: type: integer description: Reservation Cost Value total_count: type: integer description: Total Count potential_cost_savings_recommended: type: number description: Cost saved based on recommendation type: object BudgetDrift: properties: tenant_id: type: string description: Id of the tenant budget_details: type: array description: Budget_details items: $ref: '#/components/schemas/BudgetDriftDetail' type: object CostSavingsRecommendationsResponse: required: - currency_selected - saving_wise_summary properties: currency_selected: type: string description: Currency Selected saving_wise_summary: description: data filter selected if any $ref: '#/components/schemas/SavingsWiseSummary' type: object CreateMarkupRequest: allOf: - $ref: '#/components/schemas/MarkupDetails' - properties: {} type: object ListRecommendationsViewResponse: required: - classification - cloud_account_id - cloud_account_name - cost_savings - created_at - description - id - impact - name - page_count - policy_id - policy_name - projected_cost_savings_month - resource_counts - resources - service_name - source - status - sub_classification - tenant_id - tenant_name - total_count properties: id: type: string description: Recommendation id policy_id: type: string description: Policy Id policy_name: type: string description: Policy Name name: type: string description: Name status: type: string description: Status impact: type: string description: Impact based on recommendation classification: type: string description: Classification sub_classification: type: string description: Sub Classification based on classification cloud_account_id: type: string description: Cloud account id cloud_account_name: type: string description: Cloud Account Name tenant_name: type: string description: Tenant Name tenant_id: type: string description: Tenant ID x-cs-type: ObjectId service_name: type: string description: Cloud Service Name source: type: string description: Source created_at: type: string description: Time of creation projected_cost_savings_month: type: string description: Projected Cost Saving per Month resource_counts: description: The resources that are open based on recommendation $ref: '#/components/schemas/ResourceCount' description: type: string description: Description cost_savings: description: Cost Saving based on recommendation $ref: '#/components/schemas/CostSavings' total_count: type: integer description: Total Count page_count: type: integer description: Page Count resources: type: array description: Resources items: type: object type: object BudgetDriftRequest: allOf: - $ref: '#/components/schemas/CommonCostRequest' - required: - configuration_type properties: configuration_type: type: string description: Type of budget example: actual enum: - actual - forecast x-cs-enum-type: BudgetType type: object BudgetDriftDetail: properties: budget_drift: type: number description: Actual or Forecast Budget_Drift cost_spend: type: number description: Cost Spend for the clouds budget_amount: type: number description: Budget Amount. budget_name: type: string description: Name of budget type: object FinopsAssessmentTriggerResponse: properties: assessment_run_id: type: string description: Assessment run id type: object CostOptimizationCloudAccountSummaryResponse: required: - overall_savings_percentage - page_count - potential_cost_savings_total - potential_cost_savings_total_info - total_count properties: total_count: type: integer description: Total Count page_count: type: integer description: Page Count overall_savings_percentage: type: string description: Total Saving Percentage potential_cost_savings_total_info: type: string description: Potential cost savings total info potential_cost_savings_total: type: string description: Potential cost savings total account_summary: type: array items: $ref: '#/components/schemas/AccountSummary' type: object UpdateMarkupRequest: allOf: - $ref: '#/components/schemas/MarkupDetails' - properties: {} type: object TaggedUntaggedResourcesByProductCategoryRequest: allOf: - $ref: '#/components/schemas/CommonCostRequest' - properties: {} type: object CostOptimizationTrendRequest: required: - currency properties: filter: $ref: '#/components/schemas/AccountFilters' currency: type: string description: currency of the cost. Example 'currency':'USD' example: AED enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR x-cs-enum-type: Currency type: object CostOptimizationCloudAccTypeResponse: required: - data - message - status properties: status: type: string description: Response status on cloud account types message: type: string description: Listing Cloud account types retrieved successfully data: type: object description: cloud account type and cloud account name type: object AccountSummary: required: - cloud_account_id - cloud_account_name - cloud_account_type - estimated_cost - impacted_resources - monthly_cost_saving_info - monthly_cost_savings - quarterly_cost_saving_info - quarterly_cost_savings - recommendation - savings_percentage - yearly_cost_saving_info - yearly_cost_savings properties: cloud_account_id: type: string description: Cloud account id cloud_account_name: type: string description: Cloud account name cloud_account_type: type: string description: Cloud account type recommendation: type: string description: Recommendations estimated_cost: type: number description: Estimated cost monthly_cost_savings: type: number description: Monthly cost savings quarterly_cost_savings: type: number description: Quarterly cost savings yearly_cost_savings: type: number description: Yearly cost savings impacted_resources: type: integer description: Impacted resources savings_percentage: type: string description: Savings percentage monthly_cost_saving_info: type: string description: Monthly cost saving information quarterly_cost_saving_info: type: string description: Quarterly cost saving information yearly_cost_saving_info: type: string description: Yearly cost saving information type: object CostAnomalyByCloud: properties: cloud: type: string date: type: string format: date cost_anomaly: type: number type: object CostOptimizationCloudAccountSummaryRequest: required: - cloud_account_id - cloud_account_type - currency properties: page: type: integer description: 'page number.Example ''page'': 1' limit: type: integer description: 'records limits.Example ''limit'': 10' currency: type: string description: currency type cloud_account_type: type: array description: Cloud account type items: type: string cloud_account_id: type: array description: Cloud account id items: type: string type: object RangeSelection: properties: range: type: string example: Last15Minutes enum: - Last15Minutes - Last30Minutes - Last60Minutes - Hour - PreviousHour - Last3Hours - Last6Hours - Last12Hours - Last24Hours - FullDay - Today - Yesterday - Last2Days - Last3Days - Last7Days - Last14Days - Week - WeekToDate - LastWeekToNow - Last2WeeksToNow - PreviousWeek - Previous2Weeks - Previous4Weeks - FullMonth - Month - MonthToDate - PreviousMonth - LastMonthToNow - Previous3Months - Previous6Months - Previous12Months - TwoMonthsAgo - ThreeMonthsAgo - Last30Days - FullQuarter - Quarter - QuarterToDate - LastQuarterToNow - LastQuarterToDate - PreviousQuarter - Previous2Quarters - Previous3Quarters - Previous4Quarters - Last3Months - Last3MonthsToNow - Last6MonthsToNow - Last12MonthsToNow - FullYear - Year - YearToDate - PreviousYear - Previous3Years - Last365Days - BillingCurrentMonth - BillingPreviousMonth - BillingCurrentQuarter - BillingPreviousQuarter - BillingPrevious3Months - BillingPrevious6Months - FiscalPreviousQuarter - FiscalCurrentQuarter - FiscalCurrentQuarterToNow - FiscalPreviousHalfYear - FiscalCurrentHalfYear - FiscalPreviousYear - FiscalCurrentYear - FiscalCurrentYearToNow - FiscalLast3Years - FiscalYearToDate - WeekToDateT2 - LastWeekToDateT2 - Last2WeeksToDateT2 - MonthToDateT2 - LastMonthToDateT2 - Last3MonthsToDateT2 - Last6MonthsToDateT2 - Last12MonthsToDateT2 - LastQuarterToDateT2 - YearToDateT2 - FiscalLastQuarterToDateT2 - FiscalCurrentQuarterToDateT2 - FiscalCurrentYearToDateT2 - All x-cs-enum-type: TimeRangeId start: type: string format: date-time end: type: string format: date-time zoneCreated: type: string zone: type: string type: object GeoCoordinatesForRegionRequest: properties: regions: type: array items: type: string description: Region of the cloud type: object ListRecommendationsRequest: required: - cloud_account_id properties: page: type: integer description: 'page number.Example ''page'': 1' limit: type: integer description: 'records limits. Example ''limit'': 10' classification: type: string description: 'Classifications based on OSCAR pillars. Accepted values: Operation, Security, Cost, Access, Resource' sub_classification: type: string description: "Sub-Classification based on the Classification selected.\n Accepted Values:\n \"Operation\": Performance, Availability, Standards, Logging, Monitoring\n \"Security\": Data, Network, Host, Application, End Point protection, Standards\n \"Cost\": Orphaned, Config, Idle, Underutilized, Anomaly, Billing, Budget, Overutilized, Optimized\n \"Access\": Standards, Utilization\n \"Resource\": Naming Standards, Tag Pattern, Locks" recommendation_group: type: string description: 'Mention the Recommendation group. Accepted values: Policy, Advisor, Right-Size' status: type: string description: 'Status. Acceptable values: open, resolved, skipped, system_skipped' cloud_account_id: type: string description: Specify the Cloud account ID. This can be retrieved from List Cloud account API call. service_name: type: string description: 'Cloud Service Name. Example: ''service_name'': ''AWS''/''Azure''/''GCP''' type: object LicenseSummaryData: properties: virtual_machine_name: type: string description: Virtual Machine Name virtual_machine_id: type: string description: Virtual Machine ID azure_hybrid_benefit: type: string description: Azure Hybrid Benefit resource_location: type: string description: Resource Location recommendation_id: type: string description: Recommendation ID cloud_provider: type: string description: Cloud Provider for the cloud account example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName potential_cost_saving: type: number description: Potential Cost Saving service_account_name: type: string description: Service Account Name tenant_name: type: string description: Tenant Name tenant_id: type: string description: Tenant ID x-cs-type: ObjectId subscription_name: type: string description: Subscription Name subscription_id: type: string description: Subscription Id cloud_account_id: type: string description: Cloud Account ID info: type: string description: Potential Savings % compared to the Forecasted Spend savings_percentage: type: number description: Savings Percentage type: object Recommendation: required: - classification - cloud_account_id - cloud_account_name - created_at - id - impact - name - policy_id - policy_name - projected_cost_savings_month - resource_counts - service_name - source - status - sub_classification - tenant_id - tenant_name properties: id: type: string description: Recommendation id policy_id: type: string description: Policy Id policy_name: type: string description: Policy Name name: type: string description: Name status: type: string description: Status impact: type: string description: Impact classification: type: string description: Classification based on OSCAR pillar sub_classification: type: string description: Sub Classification for the classification cloud_account_id: type: string description: Cloud account id cloud_account_name: type: string description: Cloud Account Name tenant_name: type: string description: Tenant Name tenant_id: type: string description: Tenant ID x-cs-type: ObjectId service_name: type: string description: Cloud Service Name source: type: string description: Source created_at: type: string description: Time of creation projected_cost_savings_month: type: string description: Projected Cost Saving per Month resource_counts: description: The resources that are open based on the recommendation $ref: '#/components/schemas/ResourceCount' type: object CloudAccounts: required: - cloud_accounts - message - status properties: status: type: string description: Response status on cloud accounts fetched successfully message: type: string description: Cloud accounts fetched successfully cloud_accounts: type: object description: cloud account details type: object RangeValue: properties: range: description: Range value $ref: '#/components/schemas/FromToValue' type: object BatchRequest: properties: ids: type: array description: Identifiers to fetch items: type: string type: object ResourceCount: required: - open properties: open: type: integer description: The resources that are open based on the recommendation type: object ListRIRecommendationsResponse: properties: total_count: type: integer description: Total count page_count: type: integer description: Page wise count recommendations: type: array description: Recommendations suggested items: $ref: '#/components/schemas/Recommendations' type: object CreateMarkupResponse: properties: name: type: string description: Created Rule name type: object ListReservationsServiceAccountResponse: required: - cloud_account_details - overview_details - usage_details - utilization properties: cloud_account_details: description: Cloud Account Details $ref: '#/components/schemas/CloudAccountDetailsExtended' utilization: type: array description: Utilization items: $ref: '#/components/schemas/UtilizationDetails' overview_details: description: Overview $ref: '#/components/schemas/OverviewDetails' usage_details: description: Usage details $ref: '#/components/schemas/UsageDetails' type: object LicenseBenefitHubDiscountsResponse: properties: total_count: type: integer description: total count of records page_count: type: integer description: total number of page count summary_data: type: array description: Data Summary items: $ref: '#/components/schemas/LicenseSummaryData' type: object CostTagListRequest: properties: list_context: description: Optional list context $ref: '#/components/schemas/ListContext' sort: type: array description: Sort criteria items: $ref: '#/components/schemas/CostTagSortCriteria' filters: description: Filters for the request $ref: '#/components/schemas/AccountFilters' type: object SavingsWiseSummary: required: - cost_saved_current_month - cost_saved_till_date - potential_cost_saving_recommended properties: cost_saved_till_date: type: array description: Details about cost saved till date items: $ref: '#/components/schemas/CostWiseSummary' cost_saved_current_month: type: array description: Cost saved for the current month items: $ref: '#/components/schemas/CostWiseSummary' potential_cost_saving_recommended: type: array description: recommendations on cost savings items: $ref: '#/components/schemas/CostWiseSummary' type: object UsageDetails: required: - avg_percentage - reserved_hours - unused_hours - used_hours properties: reserved_hours: type: integer description: How many hours are reserved avg_percentage: type: integer description: Average Percentage used used_hours: type: integer description: How many hours are used unused_hours: type: integer description: How many hours are unused type: object ResourceCountTenant: required: - open properties: open: type: integer description: The resources that are open based on the recommendation type: object CostOptimizationByOptimizationTypesRequest: required: - currency properties: filter: $ref: '#/components/schemas/AccountFilters' currency: type: string description: currency of the cost. Example 'currency':'USD' example: AED enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR x-cs-enum-type: Currency deduplication: type: boolean description: Deduplication of the data default: false type: object ListRecommendationsTenantResponse: required: - page_count - recommendations - total_count properties: total_count: type: integer description: Total count page_count: type: integer description: Page count recommendations: type: array description: Recommendations items: $ref: '#/components/schemas/RecommendationTenant' type: object ListRecommendationsTenantRequest: properties: page: type: integer description: 'page number.Example ''page'': 1' limit: type: integer description: 'records limits.Example ''limit'': 10' classifications: type: string description: 'Classifications based on OSCAR pillars. Accepted values: Operation, Security, Cost, Access, Resource' sub_classification: type: string description: "Sub-Classification based on the Classification selected.\n Accepted Values:\n \"Operation\": Performance, Availability, Standards, Logging, Monitoring\n \"Security\": Data, Network, Host, Application, End Point protection, Standards\n \"Cost\": Orphaned, Config, Idle, Underutilized, Anomaly, Billing, Budget, Overutilized, Optimized\n \"Access\": Standards, Utilization\n \"Resource\": Naming Standards, Tag Pattern, Locks" service_name: type: string description: Name of the Cloud. Accepted values - AWS, Azure, GCP status: type: string description: 'Status. Acceptable values: open, resolved, skipped, system_skipped' service_account_id: type: string description: Mention the Cloud Account ID. Cloud Account ID can be retrieved from List Cost Savings Account Summary call. currency: type: string description: currency of the cost. Example 'currency':'USD' example: AED enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR x-cs-enum-type: Currency type: object AccountFilters: properties: tenants: type: array description: Tenants to include (all if missing) items: type: string clouds: type: array description: Cloud Providers to include (all if missing) items: type: string description: Cloud Provider to select example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName cloud_accounts: type: array description: Cloud Accounts to include (all if missing) items: type: string regions: type: array description: Regions to include (all if missing) items: type: string resource_filter: type: array description: Resources filter to filter (all if missing) items: type: string product_categories: type: array description: Product Categories to include (all if missing) items: type: string category: type: string description: Inventory Category of the resources to filter (all if missing) resource_type: type: array description: Type of Resources to include (all if missing) items: type: string type: object CloudAccountDetailsExtended: required: - cloud_account_id - cloud_account_name - currency - service_name properties: cloud_account_id: type: string description: Cloud Account Id currency: type: string description: Currency Selected service_name: type: string description: Cloud Service Name cloud_account_name: type: string description: Cloud Account Name type: object UtilizationDetails: required: - date - percentage properties: date: type: string description: Day wise utilization percentage: type: integer description: Utilization by percentage for that date type: object ModelError: required: - message properties: message: type: string description: Error response message. type: object CostOptimizationCloudAccountTypeRequest: required: - cloud_account_id - cloud_account_type - currency properties: currency: type: string description: currency type cloud_account_type: type: array description: Cloud account type items: type: string cloud_account_id: type: array description: Cloud account id items: type: string type: object RecommendationTenant: required: - classification - cloud_account_id - cloud_account_name - created_at - id - impact - name - policy_id - policy_name - projected_cost_savings_month - resource_counts - service_name - source - status - sub_classification - tenant_id - tenant_name properties: id: type: string description: Recommendation id policy_id: type: string description: Policy Id policy_name: type: string description: Policy Name name: type: string description: Name status: type: string description: Status impact: type: string description: Impact classification: type: string description: Classification based on OSCAR pillar sub_classification: type: string description: Sub Classification for the classification cloud_account_id: type: string description: Cloud account id cloud_account_name: type: string description: Cloud Account Name tenant_name: type: string description: Tenant Name tenant_id: type: string description: Tenant ID x-cs-type: ObjectId service_name: type: string description: Cloud Service Name source: type: string description: Source created_at: type: string description: Time of creation projected_cost_savings_month: type: string description: Projected Cost Saving per Month resource_counts: description: The resources that are open based on the recommendation $ref: '#/components/schemas/ResourceCountTenant' type: object CostOptimizationViewRecommendationResponse: required: - overall_savings_percentage - page_count - potential_cost_savings_total - potential_cost_savings_total_info - total_count properties: total_count: type: integer description: Total Count page_count: type: integer description: Page Count overall_savings_percentage: type: string description: Total Saving Percentage potential_cost_savings_total_info: type: string description: Potential cost savings total information potential_cost_savings_total: type: string description: Potential cost savings total recommendation_data: type: array items: $ref: '#/components/schemas/RecommendationView' type: object CommonCostRequest: required: - currency properties: filter: $ref: '#/components/schemas/AccountFilters' currency: type: string description: currency of the cost. Example 'currency':'USD' example: AED enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR x-cs-enum-type: Currency start_date: type: string format: date-time description: 'specify the start date. start_date: yyyy-mm-dd' end_date: type: string format: date-time description: 'specify the end date. end_date: yyyy-mm-dd' time_zone: type: string description: Optional timezone of the caller time_range: $ref: '#/components/schemas/RangeSelection' query: description: Query operator $ref: '#/components/schemas/QueryOperator' type: object FromToValue: properties: from: type: integer description: 'Starting value of the range.Example ''from'': 1000' to: type: integer description: 'Ending value of the range.Example ''to'': 100000' type: object UpdateMarkupResponse: properties: name: type: string description: Updated Rule name type: object CostAnomalyByCloudRequest: allOf: - $ref: '#/components/schemas/CommonCostRequest' - required: - granularity properties: granularity: type: string description: Granularity to aggregate data example: day enum: - day - week - month - quarter - year x-cs-enum-type: TrendGranularity type: object CostOptimizationByOptimizationTypes: properties: cost_savings: type: number description: savings of the optimization types cost_forecast: type: number description: forecast spend of the optimization type optimization_type: type: string description: optimization type cloud_account: type: string description: cloud account id cloud_provider: type: string description: Cloud Provider for the cloud account example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName region: type: string description: region resource_name: type: string description: resource name resource_type: type: string description: resource type resource_id: type: string description: resource_id resource_category: type: string description: resource category optimization_name: type: string description: optimization name type: object RecommendedReservationsSavingsSummaryRequest: required: - currency - term properties: tenant_ids: type: array items: type: string description: Please provide one or more tenant IDs currency: type: string description: currency of the cost. Example 'currency':'USD' example: AED enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR x-cs-enum-type: Currency services: type: array items: type: string description: List of cloud providers. example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName term: type: string description: Year, it can be OneYear or ThreeYears. default: OneYear example: OneYear enum: - OneYear - ThreeYears x-cs-enum-type: PaymentTerms payment_option: type: string description: Select a payment option, it can be No_Upfront, Partial_Upfront or All_Upfront. default: No_Upfront example: No_Upfront enum: - No_Upfront - Partial_Upfront - All_Upfront x-cs-enum-type: PaymentOptions type: object LicenseBenefitSavingRequest: required: - currency - tenant_id properties: currency: type: string description: currency of the cost. Example 'currency':'USD' example: AED enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR x-cs-enum-type: Currency service_names: type: array items: type: string description: Cloud Provider for the cloud account example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName tenant_id: type: array description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. items: type: string type: object DeleteMarkupResponse: properties: name: type: string description: Deleted Rule name type: object CostSavings: required: - charge_unit - cost - currency_code properties: charge_unit: type: string description: Charge Unit cost: type: integer description: Total cost currency_code: type: string description: Currency code type: object ApplicableToDetails: properties: name: type: string description: Applicable to which cloud account or tenant. Example 'name':'AWS_Account_1' id: type: string description: 'ID of that account.Example ''id'': ''61237f01e4b04a4c6b19addd''' type: object ListRIRecommendationsRequest: required: - currency - term properties: currency: type: string description: currency of the cost. Example 'currency':'USD' example: AED enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR x-cs-enum-type: Currency services: type: array items: type: string description: Cloud Provider for the cloud account example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName term: type: string description: Year, it can be 1 or 3 compute_forecast: type: boolean description: flag to indicate whether to include compute forecast in the response payment_option: type: string description: 'Select a payment option, it can be No_Upfront, Partial_Upfront or All_Upfront. payment_option: No_Upfront' default: No_Upfront type: object CostOptimizationTrend: properties: cloud: type: string description: Cloud Provider example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName cost_forecast: type: number potential_forecasted_cost: type: number potential_savings: type: number date: type: string format: date-time type: object FinopsAssessmentHistory: properties: assessment_run_id: type: string description: Assessment run id assessment_status: type: string description: Assessment run id status example: in_progress enum: - in_progress - pending - failed - completed x-cs-enum-type: AssessmentRunStatus assessment_status_message: type: string description: Assessment run id status message assessment_start_time: type: string format: date-time description: Assessment run start date and time type: object CostTagSortCriteria: required: - column properties: column: type: string example: Key enum: - Key x-cs-enum-type: CostTagSortColumn ascending: type: boolean type: object CostTag: properties: key: type: string description: Tag key values: type: array description: Values for the tag key items: type: string type: object ListRecommendationsResponse: required: - page_count - recommendations - total_count properties: total_count: type: integer description: Total count page_count: type: integer description: Page count recommendations: type: array description: Recommendations items: $ref: '#/components/schemas/Recommendation' type: object OverviewDetails: required: - cloud_account_name - expiry_date - instance_flexibility - number_of_RIs - payment_option - purchase_date - region - reservation_name - reservation_sku - reservation_type - scope properties: payment_option: type: string description: Payment method which is monthly or yearly instance_flexibility: type: string description: Instance Flexibility Should be on reservation_name: type: string description: Reservation Name reservation_type: type: string description: Reservation Type expiry_date: type: string description: Expiry date reservation_sku: type: string description: Reservation SKU details region: type: string description: Region where the resource is created cloud_account_name: type: string description: Name of the cloud account purchase_date: type: string description: Date of purchase number_of_RIs: type: integer description: How many RIs are present scope: type: string description: scope of the ri utilization type: object CostTagBatchResponse: properties: results: type: object description: Map from identifier to response model additionalProperties: $ref: '#/components/schemas/CostTag' type: object ListReservationsV2Request: required: - currency - date_filter properties: date_filter: type: string description: Date Filter to select example: current_month enum: - current_month - current_month_minus_1 - current_month_minus_2 - current_month_minus_3 - current_month_minus_4 - current_month_minus_5 - current_month_minus_6 - current_month_minus_7 - current_month_minus_8 - current_month_minus_9 - current_month_minus_10 - current_month_minus_11 - current_month_minus_12 x-cs-enum-type: DashboardDateFilter currency: type: string description: currency of the cost. Example 'currency':'USD' example: AED enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR x-cs-enum-type: Currency service: type: string description: cloud service name example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName tenant_ids: type: array description: One or more tenant IDs to fetch reservations across. Omit to scope to a single tenant. items: type: string description: Tenant ID x-cs-type: ObjectId type: object ResolveCostSavingsRecommendationsRequest: required: - action_name - resources properties: action_name: type: string description: Action to be applied to resolve the recommendation example: remediate_now enum: - remediate_now - submit_for_approval - schedule - reject_it x-cs-enum-type: ResolveCostSavingsRecommendationsAction resources: type: array description: Resource Id to which the recommendation should be applied. Can be fetched from 'CostSavingViewRecommendation' api. items: type: string type: object FinopsAssessmentTriggerRequest: required: - action - category properties: action: type: string description: Action that needs to be performed example: re_trigger_assessment enum: - re_trigger_assessment - trigger_data_collection x-cs-enum-type: AssessmentAction category: type: string description: Category of assessment validation for the cloud account example: operations enum: - operations - security - access - cost - resource - compliance x-cs-enum-type: AssessmentCategory type: object TopBudgetByTenantRequest: allOf: - $ref: '#/components/schemas/CommonCostRequest' - properties: {} type: object ListContext: properties: batch_size: type: integer description: Max number of ids in the response batch_offset: type: integer description: Offset of batches into the results. First batch is 0 total: type: integer description: Total number of results type: object MarkupDetails: required: - applicable_to - end_date - markup_amount - markup_type - rule_name - rule_scope - rule_type - service - start_date properties: start_date: type: string format: date description: Start date of the rule end_date: type: string format: date description: End date for that rule rule_name: type: string description: Rule name. Enter an existing Rule name or else a new one will be created rule_scope: type: string description: Scope of the rule. This field cannot be updated use the same Rule Scope. If you want to update this create a new Rule example: tenant enum: - tenant - cloud_account x-cs-enum-type: DiscountMarkupRuleScope rule_type: type: string description: Type of the markup/discount rule example: discount enum: - discount - markup - RI_discount - RI_markup - Third_Party_License x-cs-enum-type: MarkupRuleType is_active: type: boolean description: States if the rule is active or not markup_type: type: string description: Type of the markup example: fixed_amount enum: - fixed_amount - percentage x-cs-enum-type: DiscountMarkupType markup_amount: type: number description: Markup/Discount amount depending on the markup type selected service: type: string description: Cloud Provider to select example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName applicable_to: description: '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 ' $ref: '#/components/schemas/ApplicableToDetails' type: object Recommendations: properties: tenant_name: type: string description: Tenant Name cloud_account_name: type: string description: Cloud Account Name reservation_type: type: string description: Reservation type reservation_sku: type: string description: Reservation SKU Details region: type: string description: Region quantity: type: integer description: Quantity estimated_cost_savings: type: number description: How much cost is saved based on recommendation suggested cloud_account_id: type: string description: Cloud Account ID tenant_id: type: string description: Tenant ID x-cs-type: ObjectId service: type: string description: Cloud Service info: type: string description: Information savings_percentage: type: string description: Saving Percentage type: object OptimizationSummary: required: - estimated_cost - impacted_resources - info - recommendations - savings_percentage - total_Cost properties: total_Cost: type: object description: Total Cost recommendations: type: object description: Total Count savings_percentage: type: string description: Saving Percentage info: type: string description: Information estimated_cost: type: number description: forecasted cost impacted_resources: type: object description: Impacted resources type: object FinopsAssessmentTriggerStatusResponse: properties: status: type: string description: Assessment run id status example: in_progress enum: - in_progress - pending - failed - completed x-cs-enum-type: AssessmentRunStatus status_message: type: string description: Assessment run id status message type: object TaggedUntaggedResourcesByProductCategory: properties: untagged_resources: type: number description: Cost for all untagged resources in category tagged_resources: type: number description: Cost for all tagged resources in category product_category: type: string description: product category type type: object GeoCoordinatesForRegion: properties: latitude: type: number longitude: type: number iso_a3_code: type: string region: type: string normalized_region: type: string type: object TopRecommendations: required: - message - status - top_recommendations properties: status: type: string description: Response status on resource wise top recommendations message: type: string description: top recommendations list top_recommendations: type: object description: Top Recommendation type: object ReservationDetails: required: - cloud_account_id - cloud_account_name - expiry_date - payment_option - region - reservation_id - reservation_sku - ri_hours_used - tenant_name - utilization_percentage properties: tenant_name: type: string description: Tenant Name tenant_id: type: string description: Tenant ID x-cs-type: ObjectId reservation_id: type: string description: Reservation Id payment_option: type: string description: What is the payment option ri_hours_used: type: string description: RI hours being used expiry_date: type: string description: Date of expiry reservation_sku: type: string description: Reservation SKU Details region: type: string description: Region cloud_account_name: type: string description: Cloud Account Name cloud_account_id: type: string description: Cloud Account Id utilization_percentage: type: string description: Utilization by percentage type: object securitySchemes: auth_token: type: apiKey in: header name: X-Auth-Token