{ "opencollection": "1.0.0", "info": { "name": "CoreStack External API", "version": "1.0.0" }, "items": [ { "info": { "name": "Access", "type": "folder" }, "items": [ { "info": { "name": "Get Access Summary Count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/access/posture/governance_summary/list", "params": [ { "name": "services", "value": "", "type": "query", "description": "Supported services for Access Dashboard. Select one from the dropdown to display summary for that particular service" } ] }, "docs": "Displays the summary of the violations based on the cloud provider" }, { "info": { "name": "Get Access Summary Dashboard Count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/access/posture/governance_summary_dashboard", "params": [ { "name": "services", "value": "", "type": "query", "description": "Select one from the supported services to display summary for that particular service" }, { "name": "tenant_id", "value": "", "type": "query", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Displays the summary of the violations" }, { "info": { "name": "Get Access Violations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/access/posture/view_violations", "params": [ { "name": "services", "value": "", "type": "query", "description": "Supported services for Access Dashboard. Select one from the dropdown to display violations of all the accounts for that particular service" }, { "name": "tenant_ids", "value": "", "type": "query", "description": "Specify the tenant ID as comma separated. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "search", "value": "", "type": "query", "description": "Search by account_name wise" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "limit", "value": "", "type": "query", "description": "Limit of the data to be displayed" } ] }, "docs": "Displays the violations based on the cloud provider" }, { "info": { "name": "Get Access Detail", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/access/visibility/details", "params": [ { "name": "services", "value": "", "type": "query", "description": "Supported services for Access Dashboard. Select one from the dropdown to display details for that particular service" }, { "name": "category", "value": "", "type": "query", "description": "Category under which a particular violation falls in a particular cloud account. Please get category from the guardrail of AccessVisibilityFilters in Access Visibility Dashboard" }, { "name": "item", "value": "", "type": "query", "description": "Name of the violation. Please get name from the guardrail of AccessVisibilityFilters in Access Visibility Dashboard" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "limit", "value": "", "type": "query", "description": "Limit of the data to be displayed" } ] }, "docs": "Displays the details of individual violation" }, { "info": { "name": "Get Access Visibility Filter", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/access/visibility/filter", "params": [ { "name": "services", "value": "", "type": "query", "description": "Supported services for Access Dashboard. Select one from the dropdown to display filter for that particular service" } ] }, "docs": "Displays the filters by tenants, cloud accounts, guardrail" } ] }, { "info": { "name": "Budget V2 Management", "type": "folder" }, "items": [ { "info": { "name": "Create Budget", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/budget/create" }, "docs": "Budget Create" }, { "info": { "name": "View Count Budget Alert Exceeds Summary", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/budget/dashboard/budget_alert_exceeds_count" }, "docs": "Budget Alert Exceed Count" }, { "info": { "name": "View Count Budget Summary", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/budget/dashboard/budget_summary_count" }, "docs": "Budget Summary Count" }, { "info": { "name": "View Budget Dashboard", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/budget/dashboard/list_budgets" }, "docs": "List Budget Management" }, { "info": { "name": "View Create Budget Advanced Filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/budget/filter_values" }, "docs": "Filter Budget Management" }, { "info": { "name": "Delete Budget", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/budget/item/:budget_id", "params": [ { "name": "budget_id", "value": "", "type": "path", "description": "Specify the budget ID.This is a unique ID and can be retrieved using the create budget" } ] }, "docs": "Delete Budget" }, { "info": { "name": "Update Budget", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/budget/update" }, "docs": "Budget Update" }, { "info": { "name": "List Budget History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/budget/:budget_id/budget_history", "params": [ { "name": "budget_id", "value": "", "type": "path", "description": "Specify the budget ID.This is a unique ID and can be retrieved using the create budget" } ] }, "docs": "Budget History" }, { "info": { "name": "List Budget Detail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/budget/:budget_id/view", "params": [ { "name": "budget_id", "value": "", "type": "path", "description": "Specify the budget ID.This is a unique ID and can be retrieved using the create budget" } ] }, "docs": "View Budget" }, { "info": { "name": "Update Budget Threshold Alerts", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/budgets/threshold_alerts/update" }, "docs": "ThresholdAlert Update" }, { "info": { "name": "View Budget Threshold Alerts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/budgets/threshold_alerts/view", "params": [ { "name": "expand", "value": "", "type": "query", "description": "to view threshold list data" } ] }, "docs": "ThresholdAlert View" } ] }, { "info": { "name": "Compliance", "type": "folder" }, "items": [ { "info": { "name": "Get compliance assessment summary by assessment job number", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/compliance/compliance_control_mapping/assessment_summary_by_job", "params": [ { "name": "assessment_job_number", "value": "", "type": "query", "description": "Specify the assessment_job_number.This can be fetched from List Compliance Control Assessment History API." } ] }, "docs": "To get the summary of compliance assessment for the given assessment job number." }, { "info": { "name": "Compliance Security Dashboard Summary", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/compliance/executive_dashboard/compliance" }, "docs": "Security Dashboard Compliance" }, { "info": { "name": "Compliance Control Health by Control Categories", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/compliance/executive_dashboard/control_health" }, "docs": "Compliance Control Health" }, { "info": { "name": "Compliance Risks By Cloud Accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/compliance/executive_dashboard/risk" }, "docs": "Compliance Risk by Cloud Accounts" }, { "info": { "name": "Get Compliance assessment posture Summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/compliance/posture_summary/list" }, "docs": "objective is to return the compliance assessment posture summary of all the applicable tenants" }, { "info": { "name": "List Compliance Control Assessment History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/compliance/:tenant_id/assessment_history/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. " }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "search", "value": "", "type": "query", "description": "search assessment" } ] }, "docs": "objective is to return all of the compliance assessment triggered in the tenant" }, { "info": { "name": "List compliance control mapping, get_assessment_job_details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/compliance/:tenant_id/compliance_control_mapping/get_assessment_job_details", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. " } ] }, "docs": "objective is to return Policy Job execution status for given, the tenant,assessment job number, policy id as input" }, { "info": { "name": "List compliance control mapping, get_on_audit_entries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/compliance/:tenant_id/compliance_control_mapping/get_on_audit_entries", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using theList Tenants API. " }, { "name": "assessment_job_number", "value": "", "type": "query", "description": "Specify the assessment_job_number.This can be fetched from List Compliance Control Assessment History API." } ] }, "docs": "objective is to return all of the compliance Mapping get_on_audit_entries given, the tenant,assessment job number as input" }, { "info": { "name": "Compliance On Demand Control_execute", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/compliance/:tenant_id/control_mapping/on_demand_execute_control", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Compliance On Demand Control_execute" }, { "info": { "name": "Compliance On Demand Standard_execute", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/compliance/:tenant_id/control_mapping/on_demand_execute_standard", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Compliance On Demand Standard_execute" }, { "info": { "name": "List Compliance Controls", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/compliance/:tenant_id/controls/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "compliance_uri", "value": "", "type": "query", "description": "uri of compliance standard, This can be fetched from the compliance standards list API call." } ] }, "docs": "Objective is to return all of the compliance controls given, the tenant and compliance standard as input" }, { "info": { "name": "List Compliance Control Mappings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/compliance/:tenant_id/mapping/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. " }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "caller", "value": "", "type": "query", "description": "type of data requested" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "compliance_uri", "value": "", "type": "query", "description": "uri of compliance standard This can be fetched from the compliance standards list API call." } ] }, "docs": "objective is to return all of the compliance control mappings given, the tenant and compliance standard as input" }, { "info": { "name": "List Compliance Standards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/compliance/:tenant_id/standards", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. " }, { "name": "type", "value": "", "type": "query", "description": "Select the Type of Compliance Standard" }, { "name": "valid_service_type", "value": "", "type": "query", "description": "Select a Valid Service Type" }, { "name": "scope", "value": "", "type": "query", "description": "Select the scope of Compliance Standard" }, { "name": "framework", "value": "", "type": "query", "description": "true/false flag to fetch framework standards" } ] }, "docs": "Objective is to return all of the compliance standards given, the tenant as input" }, { "info": { "name": "List Compliance Visibility", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/compliance/:tenant_id/visibility", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. " }, { "name": "service_account_id", "value": "", "type": "query", "description": "ID of the cloud account. This can be fetched from ListCloudAccounts API" }, { "name": "compliance_type", "value": "", "type": "query", "description": "Select a Valid Compliance Type" }, { "name": "service_resource_type", "value": "", "type": "query", "description": "Specify the service resource type,this can be fetched from the corestack" }, { "name": "compliance_uri", "value": "", "type": "query", "description": "uri of compliance standard, This can be fetched from the compliance standards list API call." } ] }, "docs": "objective is to return all of the compliance visibility given, the tenant as input" }, { "info": { "name": "List Compliance posture DetailsForPolicies", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/compliance_posture/detail_for_policy/:policy_id", "params": [ { "name": "policy_id", "value": "", "type": "path" }, { "name": "status", "value": "", "type": "query", "description": "status of resource to filter" }, { "name": "search", "value": "", "type": "query", "description": "Allowed values:resource_type, resource_name, resource_id" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" } ] }, "docs": "Objective is to return all of the compliance posture DetailsForPolicies" }, { "info": { "name": "List Compliance Filter", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/compliance_posture/filters" }, "docs": "objective is to return all of the compliance Filter given, the tenant as input" }, { "info": { "name": "List Compliance Filter For Heatstack", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/compliance_posture/filters/by_policy", "params": [ { "name": "tenant_id", "value": "", "type": "query", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "policy_filters", "value": "", "type": "query", "description": "true/false flag to get policies filter as well" } ] }, "docs": "Objective is to return all of the compliance Filter given, the tenant as input" }, { "info": { "name": "List Compliance Filter_Policy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/compliance_posture/policy_filters", "params": [ { "name": "tenant_id", "value": "", "type": "query", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "standards", "value": "", "type": "query", "description": "compliance standards to filter policies" }, { "name": "severity", "value": "", "type": "query", "description": "severity filter" }, { "name": "search", "value": "", "type": "query", "description": "matches policy name, display_name, engine_type, severity, services, resource_type and service_resource " }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" } ] }, "docs": "Objective is to return all of the compliance Filter Policy given, the tenant as input" }, { "info": { "name": "List compliance_posture summary_by_accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/compliance_posture/summary_by_accounts", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "search", "value": "", "type": "query", "description": "Allowed values:account,standard,service" } ] }, "docs": "objective is to return all of the compliance summary_by_accounts" }, { "info": { "name": "List Compliance posture SummaryByPolicies", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/compliance_posture/summary_by_policies", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "search", "value": "", "type": "query", "description": "Allowed values:account,standard,service" } ] }, "docs": "Objective is to return all of the compliance posture SummaryByPolicies" }, { "info": { "name": "Clean Up Unmapped Policy Data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/compliance/control_mapping/cleanup_policy_data" }, "docs": "Cleanup the data in compliance that was created by deprecated policy" }, { "info": { "name": "Get compliance standard assessments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:tenant_id/assessment_history", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "search", "value": "", "type": "query", "description": "Allowed values:account,standard,service" }, { "name": "compliance_uri", "value": "", "type": "query", "description": "uri of compliance standard, This can be fetched from the compliance standards list API call." }, { "name": "service_account", "value": "", "type": "query", "description": "ID of the cloud account. This can be fetched from ListCloudAccounts API" }, { "name": "assessment_status", "value": "", "type": "query", "description": "Specify the assessment_status." }, { "name": "assessment_type", "value": "", "type": "query", "description": "Specify the assessment_type." } ] }, "docs": "Objective is to return all of the compliance control mapping, the tenant as input" }, { "info": { "name": "compliance posture visibility", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:tenant_id/compliance_posture/:service_account_id/visibility", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "service_account_id", "value": "", "type": "path" }, { "name": "compliance_uri", "value": "", "type": "query", "description": "uri of compliance standard This can be fetched from the compliance standards list API call." }, { "name": "group_by", "value": "", "type": "query", "description": "Group by attribute (Allowed Values: control_family, resource_type, severity, region) " }, { "name": "count_by", "value": "", "type": "query", "description": "Allowed Values: control, policy and resource." }, { "name": "group_by_filter", "value": "", "type": "query", "description": "allowed values for selected group by" }, { "name": "filters_required", "value": "", "type": "query", "description": "true/false flag to identify whether filters is required or not" }, { "name": "details_required", "value": "", "type": "query", "description": "true/false flag to identify whether detail is required or not" } ] }, "docs": "Objective is to return all of the compliance Visibility" }, { "info": { "name": "compliance visibility trend", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:tenant_id/compliance_posture/:service_account_id/visibility_trend", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "service_account_id", "value": "", "type": "path" }, { "name": "compliance_uri", "value": "", "type": "query", "description": "uri of compliance standard This can be fetched from the compliance standards list API call." }, { "name": "period", "value": "", "type": "query", "description": "date range filter (Allowed values: current_month, previous_month, last_3_months, last_10_assessments) " }, { "name": "count_by", "value": "", "type": "query", "description": "Allowed Values: control, policy and resource" } ] }, "docs": "Objective is to return all of the compliance VisibilityTrend" } ] }, { "info": { "name": "Cost", "type": "folder" }, "items": [ { "info": { "name": "List Cost Saving Recommendation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cost/cost_savings/accounts/visibility/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "list recommendation" }, { "info": { "name": "View Cost Saving Recommendation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cost/cost_savings/accounts/visibility/:tenant_id/recommendations/:recommendation_id/view", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "recommendation_id", "value": "", "type": "path", "description": "Recommendation Id.Can be fetched from '/cost/cost_savings/accounts/visibility/{tenant_id}' or '/cost/cost_savings/tenants/visibility/{tenant_id}' api" } ] }, "docs": "view recommendation" }, { "info": { "name": "List Cost Saving Recommendations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cost/cost_savings/cost_saved_recommendation", "params": [ { "name": "currency", "value": "", "type": "query", "description": "Currency to fetch the data" } ] }, "docs": "view cost saving recommendation" }, { "info": { "name": "List Cost Saving Recommendation by Tenant", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cost/cost_savings/tenants/visibility/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "list recommendation tenant" }, { "info": { "name": "Resolve Cost Savings Recommendations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/cost_savings/:tenant_id/resolve_recommendation/:recommendation_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "recommendation_id", "value": "", "type": "path", "description": "Recommendation Id.Can be fetched from '/cost/cost_savings/accounts/visibility/{tenant_id}' or '/cost/cost_savings/tenants/visibility/{tenant_id}' api" } ] }, "docs": "Resolve cost savings recommendation" }, { "info": { "name": "License Benefit Hub Discounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/costoptimizer/optimizerate/license_benefit/hub_discounts" }, "docs": "License Benefit" }, { "info": { "name": "License Benefit Cost Savings Summary", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/costoptimizer/optimizerate/license_benefit/saving_summary" }, "docs": "License Benefit" }, { "info": { "name": "Tenant Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cost/costoptimizer/optimizeusage/tenant", "params": [ { "name": "request_type", "value": "", "type": "query", "description": "select the request type" } ] }, "docs": "Under cost optimization Tenant ID and Tenant details" }, { "info": { "name": "Overall Cloud Account Summary", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/costoptimizer/optimizeusage/:tenant_id/cloud_account_summary", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "request_type", "value": "", "type": "query", "description": "select the request type" } ] }, "docs": "cost optimization overall cloud account summary" }, { "info": { "name": "Cloud Account Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/costoptimizer/optimizeusage/:tenant_id/cloud_account_type", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "request_type", "value": "", "type": "query", "description": "select the request type" } ] }, "docs": "fetch cloud account details" }, { "info": { "name": "View Cloud Account_ID and Cloud Account Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cost/costoptimizer/optimizeusage/:tenant_id/cloud_accounts", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "currency", "value": "", "type": "query", "description": "select mode of currency" }, { "name": "service_name", "value": "", "type": "query", "description": "select cloud account type" }, { "name": "request_type", "value": "", "type": "query", "description": "select the request type" } ] }, "docs": "fetch cloud account_id and cloud account name" }, { "info": { "name": "View Tenant Wise Currency's Or Cloud Account Type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cost/costoptimizer/optimizeusage/:tenant_id/filter", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "services", "value": "", "type": "query", "description": "view cloud account type" }, { "name": "currency", "value": "", "type": "query", "description": "view currency" }, { "name": "service_name", "value": "", "type": "query", "description": "select the cloud type" }, { "name": "request_type", "value": "", "type": "query", "description": "select the request type" } ] }, "docs": "view tenant wise currency or cloud account type" }, { "info": { "name": "Tenant Wise Cost Summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cost/costoptimizer/optimizeusage/:tenant_id/summary", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "service_name", "value": "", "type": "query", "description": "select the cloud account type" }, { "name": "currency", "value": "", "type": "query", "description": "select the mode of currency" }, { "name": "request_type", "value": "", "type": "query", "description": "select the request type" } ] }, "docs": "under cost optimization tenant wise summary" }, { "info": { "name": "View Resource Wise Cost Details Under Cloud Account ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cost/costoptimizer/optimizeusage/:tenant_id/top_recommendations", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "recommendation_id", "value": "", "type": "query", "description": "provide recommendation_id" }, { "name": "resource_id", "value": "", "type": "query", "description": "provide resource_id" }, { "name": "cloud_account_id", "value": "", "type": "query", "description": "provide cloud_account_id" }, { "name": "currency", "value": "", "type": "query", "description": "select mode of currency" }, { "name": "resource_type", "value": "", "type": "query", "description": "provide resource_type" } ] }, "docs": "Fetch Cost Optimization Top Recommendation as per resource IDs" }, { "info": { "name": "Resource Wise Recommendation(Savings) Data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/costoptimizer/optimizeusage/:tenant_id/view_recommendations", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "resource_status", "value": "", "type": "query", "description": "resource status" }, { "name": "request_type", "value": "", "type": "query", "description": "select the request type" } ] }, "docs": "Cost Optimization Resource wise Recommendation(saving) data" }, { "info": { "name": "Get Actual or Forecast Budget Drift", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/executive_dashboard/budget_drift" }, "docs": "View Current or Forecast budget drift." }, { "info": { "name": "Get Cost Spend By Cloud and Resource Category", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/executive_dashboard/cost_anomalies_by_cloud" }, "docs": "View Cost Anomalies By Cloud." }, { "info": { "name": "cost optimization by optimization type", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/executive_dashboard/cost_optimization_by_optimization_types" }, "docs": "View Cost Optimization By Optimization Types." }, { "info": { "name": "Get cost optimization trend", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/executive_dashboard/cost_optimization_trend" }, "docs": "View cost optimization trend." }, { "info": { "name": "geo coordinates for regions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/executive_dashboard/geo_coordinates_for_regions" }, "docs": "View Geo Coordinates For Regions." }, { "info": { "name": "Get Tagged and Untagged Resources Cost By Product Category", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/executive_dashboard/tagged_and_untagged_resources" }, "docs": "View Tagged and Untagged Resources By Product Category." }, { "info": { "name": "Get Top Budget By Tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/executive_dashboard/top_budgets" }, "docs": "View Top Budget By Tenant." }, { "info": { "name": "Create Cost Markup Rule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cost/markups_and_discounts/:tenant_id/create", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "create Markup rule" }, { "info": { "name": "Delete Cost Markup Rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/cost/markups_and_discounts/:tenant_id/delete", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "rule_name", "value": "", "type": "query", "description": "Specify the rule name to be deleted" } ] }, "docs": "delete Markup rule" }, { "info": { "name": "List Cost Markup Rules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cost/markups_and_discounts/:tenant_id/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "action", "value": "", "type": "query", "description": "Specify the action to fetch markup data" }, { "name": "scope", "value": "", "type": "query", "description": "Specify the scope to fetch markup data" } ] }, "docs": "list Markup rules" }, { "info": { "name": "Update Cost Markup Rule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cost/markups_and_discounts/:tenant_id/update", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "update Markup rule" }, { "info": { "name": "List Recommendations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/ri/recommendation" }, "docs": "View RI Recommendations Reservations" }, { "info": { "name": "List Cost Reservations & Utilization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cost/ri/utilization/reservations", "params": [ { "name": "date_filter", "value": "", "type": "query", "description": "Date Filter to select" }, { "name": "currency", "value": "", "type": "query", "description": "Currency to fetch the data" }, { "name": "service", "value": "", "type": "query", "description": "cloud service name" } ] }, "docs": "list reservation utilization" }, { "info": { "name": "List Cost Reservations & Utilization (multi-tenant)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost/ri/utilization/reservations" }, "docs": "list reservation utilization across one or more tenants in a single call" }, { "info": { "name": "List Cost Reservations & Utilization by Cloud Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cost/ri/utilization/:cloud_account_id/reservations/:reservation_id", "params": [ { "name": "cloud_account_id", "value": "", "type": "path", "description": "Specify the Cloud Account ID. This can be fetched from List CloudAccounts API call." }, { "name": "reservation_id", "value": "", "type": "path", "description": "Specify the Reservation ID for the Cloud Account. This can be fetched from List Cost Reservations & Utilizations API call." }, { "name": "date_filter", "value": "", "type": "query", "description": "Date Filter to select" } ] }, "docs": "list reservation utilization cloud account wise" }, { "info": { "name": "Saving Summary for Recommended Reservations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/cost/costoptimizer/optimizerate/long_term_savings/recommended_reservations/savings_summary" }, "docs": "Recommended Reservations Savings Summary" }, { "info": { "name": "Finops Assessment Trigger", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/cost/finops_assessment_trigger/:tenant_id/:cloud_account_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "cloud_account_id", "value": "", "type": "path", "description": "Specify the cloud account ID. This is a unique ID and can be retrieved using the List cloud account API." } ] }, "docs": "Trigger FinOps Assessment" }, { "info": { "name": "Finops Assessment Trigger History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/cost/finops_assessment_trigger_history/:cloud_account_id", "params": [ { "name": "cloud_account_id", "value": "", "type": "path", "description": "Specify the cloud account ID. This is a unique ID and can be retrieved using the List cloud account API." } ] }, "docs": "History of Triggered FinOps Assessment in Desc order" }, { "info": { "name": "Finops Assessment Trigger Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/cost/finops_assessment_trigger_status/:assessment_run_id", "params": [ { "name": "assessment_run_id", "value": "", "type": "path", "description": "Specify the assessment run ID. This is a unique ID and can be retrieved using the Finops Assessment Trigger API." } ] }, "docs": "Status of Triggered FinOps Assessment" }, { "info": { "name": "Returns a batch of CostTag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/cost/tags/batch" }, "docs": "Batch Tags" }, { "info": { "name": "Returns a list of CostTag ids", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/cost/tags/list" }, "docs": "List Tags" } ] }, { "info": { "name": "Cost Anomaly", "type": "folder" }, "items": [ { "info": { "name": "Get Account wise daily Billing Cost Anomaly", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost_anomaly/billing_cost_anomaly" }, "docs": "View Billing Cost Anomaly Data." }, { "info": { "name": "Get Account wise daily Billing Cost Anomaly Resources", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost_anomaly/billing_cost_anomaly_resources" }, "docs": "View Billing Cost Anomaly Resources." }, { "info": { "name": "Reject Billing Cost Anomaly", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cost_anomaly/reject_anomaly" }, "docs": "Reject Anomaly" }, { "info": { "name": "Trigger cost anomaly detection for a dimension, optionally filtered by grouping rules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/cost_anomaly/dimension/trigger" }, "docs": "Trigger cost anomaly detection for a dimension, using grouping rules as filters." }, { "info": { "name": "Reject Billing Cost Anomaly for Grouping Rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/cost_anomaly/dimension_grouping_rule/reject" }, "docs": "Reject Anomaly Grouping Rule" }, { "info": { "name": "Get grouping rule–wise daily cost anomalies", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/cost_anomaly/dimension_grouping_rule_view" }, "docs": "Retrieve grouping rule–wise cost anomalies." } ] }, { "info": { "name": "Assessment", "type": "folder" }, "items": [ { "info": { "name": "Assessment Validation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/governance/account/settings/access/post/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Analyse the access requirements for the given cloud account." }, { "info": { "name": "Assessment Compliance Validation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/governance/account/:tenant_id/compliance_standards/:cloud_account_id/get_configurations", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "cloud_account_id", "value": "", "type": "path", "description": "ID of the cloud account. This can be fetched from ListCloudAccounts API" } ] }, "docs": "Creates a Assessment Validation list for compliance under the tenant." } ] }, { "info": { "name": "Account Governance", "type": "folder" }, "items": [ { "info": { "name": "Config Validation Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/governance/account/:tenant_id/cloud_account/:cloud_account_id/config_validation", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "cloud_account_id", "value": "", "type": "path", "description": "Specify the cloud account id to update, cloud account id is unique can be obtained from the list cloud account api. This should be same as the ID of the reference APIFor Azure CSP-Direct subscriptions, this can be fetched from list child accounts api." } ] }, "docs": "Config validation based on the policy engine" }, { "info": { "name": "Assessment Validation Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/governance/account/:tenant_id/create/:cloud_account_id/assessment_validation_result", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "cloud_account_id", "value": "", "type": "path", "description": "Specify the cloud account id to update, cloud account id is unique can be obtained from the list cloud account api. This should be same as the ID of the reference APIFor Azure CSP-Direct subscriptions, this can be fetched from list child accounts api." } ] }, "docs": "Assessment validation for Operations, Cost, Security, Access and Resource." }, { "info": { "name": "Assessment Re-Validation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/governance/account/:tenant_id/create/:cloud_account_id/revalidate_assessment", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "cloud_account_id", "value": "", "type": "path", "description": "Specify the cloud account id to assess a cloud account, cloud account id is unique can be obtained from the list cloud account api. This should be same as the ID of the reference APIFor Azure CSP-Direct subscriptions, this can be fetched from list child accounts api." } ] }, "docs": "Assessment revalidation for Operations, Cost, Security, Access and Resource." }, { "info": { "name": "Assessment Results", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/governance/account/:tenant_id/get/:cloud_account_id/assessment_validation_result", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "cloud_account_id", "value": "", "type": "path" } ] }, "docs": "Displays the results of assessment with summary and history of the cloud account for OSCAR" } ] }, { "info": { "name": "Guardrails", "type": "folder" }, "items": [ { "info": { "name": "List of policy details fetched for given policy uris or policy ids", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/governance/guardrails/policies/batch" }, "docs": "Fetch policy details for given policy uris or policy ids. Supports a maximum of 1000 results per request\nSupports a maximum of 1000 results per request" }, { "info": { "name": "Create Policy Schedules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/governance/guardrails/policies/:tenant_id/create", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "create policy schedules" }, { "info": { "name": "Delete Policy Schedules", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/governance/guardrails/policies/:tenant_id/delete/:schedule_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "schedule_id", "value": "", "type": "path", "description": "Specify the schedule Id to fetch the schedule data" } ] }, "docs": "Delete policy schedules" }, { "info": { "name": "View Policy Schedules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/governance/guardrails/policies/:tenant_id/get/:schedule_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "schedule_id", "value": "", "type": "path", "description": "Specify the schedule Id to fetch the schedule data" } ] }, "docs": "view policy schedules" }, { "info": { "name": "List Policy Schedules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/governance/guardrails/policies/:tenant_id/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "list policy schedules" }, { "info": { "name": "Update Policy Schedules", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/governance/guardrails/policies/:tenant_id/update/:schedule_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "schedule_id", "value": "", "type": "path", "description": "Specify the schedule Id to fetch the schedule data" } ] }, "docs": "update policy schedules" }, { "info": { "name": "Create Policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/governance/guardrails/:tenant_id/policies", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Creates a new policy under the tenant which will generate a unique policy id in the response this is can be used to describe details about the policy, update policy, execute or delete policy. However the policy will be accessible based on its scope Account scope - All users under that account will have access to describe and execute. Only Account admins can update/delete. Tenant - Users with access to the specific tenant will have access scripts to describe and execute. Tenant admins can update" }, { "info": { "name": "List of policy details fetched for given policy uris", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/governance/guardrails/:tenant_id/policies/batch", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Fetch policy details for given policy uris" }, { "info": { "name": "List Policies", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/governance/guardrails/:tenant_id/policies/list", "params": [ { "name": "tenant_id", "value": "", "type": "path" } ] }, "docs": "List all the policies. Global Policies Scope- All user will have access to Corestack Marketplace Policies these policies cannot be updated and deleted can be only describe and executed. Account Scope:- All users under that account will have access to view and execute Only Account admins can update/delete the policies.Tenant Scope - Users with access to the specific tenant will have access to policies who can describe or execute policies. Tenant admins can only update/delete. Private Scope - Use" }, { "info": { "name": "Validate parameters for a given policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/governance/guardrails/:tenant_id/policies/validate_parameters", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Validate a set of parameters for a given policy" }, { "info": { "name": "Describe Policy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/governance/guardrails/:tenant_id/policies/:policy_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy id to execute, policy id can be obtained from the list policy api" } ] }, "docs": "Describe the already created Polices" }, { "info": { "name": "Update Policy", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/governance/guardrails/:tenant_id/policies/:policy_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy id to execute, policy id can be obtained from the list policy api" } ] }, "docs": "Update Policy details if required after creation using the api, the update by a user depends on the scope of the policy created check create policy docs for more details on the scope" }, { "info": { "name": "Delete Policy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/governance/guardrails/:tenant_id/policies/:policy_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy id to execute, policy id can be obtained from the list policy api" } ] }, "docs": "Delete a policy which is no more required" }, { "info": { "name": "Execute Policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/governance/guardrails/:tenant_id/policies/:policy_id/execute", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy id to execute, policy id can be obtained from the list policy api" } ] }, "docs": "Execute policy will return a unique job id the status of the policy can be checked using the Job details api where you can pass the unique id generated to get the details or errors if any on execution" }, { "info": { "name": "Describe Policy Job Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/governance/guardrails/:tenant_id/policy_jobs/:job_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "job_id", "value": "", "type": "path", "description": "Specify the job id to retrieve details of policy execution, job id is unique can be obtained from the execute policy response" } ] }, "docs": "Retrieve policy job details using the unique job id, this can be used to check the status of the policy execution or any failure\n:param tenant_id:\n:param job_id:\n:return:" }, { "info": { "name": "List Policy Recommendations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/governance/guardrails/:tenant_id/recommendations", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "policy_id", "value": "", "type": "query", "description": "Specify the policy id for the recommendations which is a unique id can be obtained from policy listing api" }, { "name": "cloud_account_id", "value": "", "type": "query", "description": "Specify the cloud account id for the recommendation which is a unique id can be retrieved from the cloud listing api" } ] }, "docs": "Policy recommendations are the guide line to the users to solve a policy violation by executing the recommendations the this can be a instruction or a combination of multipleinstructions defined to solve a problem" }, { "info": { "name": "Describe Policy Recommendations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/governance/guardrails/:tenant_id/recommendations/:recommendation_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "recommendation_id", "value": "", "type": "path", "description": "This is a unique identifier for recommendation, can be obtained from the PolicyRecommendations api response" } ] }, "docs": "This is the api to view the recommendation associated with the policy and the resources which will get effected on execution of the recommendations. We can also get a idea on the actions which can be performed" }, { "info": { "name": "Execute Policy Recommendation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/governance/guardrails/:tenant_id/recommendations/:recommendation_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "recommendation_id", "value": "", "type": "path", "description": "This is a unique identifier for recommendation, can be obtained from the PolicyRecommendations api response" } ] }, "docs": "This is the api to execute recommendations for a policy violation, The recommended steps to resolve the violations can be executed with the help of data like action_name, resource_recommendation_id, will be available in Recommendation View API. The Recommendations can be executed with dynamic parameter which may or may not be passed in the input" }, { "info": { "name": "Get Policy parameter configuration Master Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/master_accounts/:master_account_id/policy_configurations/:policy_id", "params": [ { "name": "master_account_id", "value": "", "type": "path", "description": "Specify the master account id to fetch the configuration for master account." }, { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy id to configure, policy id can be obtained from the list policy api" } ] }, "docs": "Fetch the Policy parameters configuration for a master account level" }, { "info": { "name": "Update Policy parameter configuration Master Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/master_accounts/:master_account_id/policy_configurations/:policy_id", "params": [ { "name": "master_account_id", "value": "", "type": "path", "description": "Specify the master account id to configure the policy parameters." }, { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy id to configure, policy id can be obtained from the list policy api" } ] }, "docs": "Update Policy configuration parameters for a master account level" }, { "info": { "name": "Delete Policy parameter configuration Master Account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/master_accounts/:master_account_id/policy_configurations/:policy_id", "params": [ { "name": "master_account_id", "value": "", "type": "path", "description": "Specify the master account id to delete the policy configuration." }, { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy id to delete configuration, policy id can be obtained from the list policy api" } ] }, "docs": "Delete Policy configuration parameters for a master account level" }, { "info": { "name": "List of policy job details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/policies/policy_jobs/batch" }, "docs": "Returns a list of job execution details for given policy job ids" }, { "info": { "name": "List accounts for policy configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/policy/configuration/policy/:policy_id/tenant/:tenant_id/service_account_list", "params": [ { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy_id to retrieve the configured service accounts. Policy id can be obtained from the list policy api" }, { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Get list of cloud accounts that are configured for policy." }, { "info": { "name": "Get Policy parameter configuration Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/policy/configuration/:policy_id/service_account/:service_account_id", "params": [ { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy id to configure, policy id can be obtained from the list policy api" }, { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account id to fetch the configuration for service account." } ] }, "docs": "Fetch the Policy parameters configuration for a cloud account level" }, { "info": { "name": "Update Policy parameter configuration Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/policy/configuration/:policy_id/service_account/:service_account_id", "params": [ { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy id to configure, policy id can be obtained from the list policy api" }, { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account id to configure the policy parameters." } ] }, "docs": "Update Policy configuration parameters for a cloud account level" }, { "info": { "name": "Delete Policy parameter configuration Account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/policy/configuration/:policy_id/service_account/:service_account_id", "params": [ { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy id to delete configuration, policy id can be obtained from the list policy api" }, { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account id to delete the policy configuration." } ] }, "docs": "Delete Policy configuration parameters for a cloud account level" }, { "info": { "name": "Get account policy configuration batch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/policy/configuration/:policy_id/service_account_batch", "params": [ { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy_id to retrieve the configured service accounts. Policy id can be obtained from the list policy api" } ] }, "docs": "Get policy configurations for cloud accounts batch." }, { "info": { "name": "Get Policy parameter configuration tenant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/policy/configuration/:policy_id/tenant/:tenant_id", "params": [ { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy id to fetch the configuration for tenant. Policy id can be obtained from the list policy api" }, { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Fetch the configured Policy parameters configuration for a tenant" }, { "info": { "name": "Update Policy parameter configuration Tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/policy/configuration/:policy_id/tenant/:tenant_id", "params": [ { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy id to configure for the tenant, policy id can be obtained from the list policy api" }, { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Update Policy configuration parameters for a tenant" }, { "info": { "name": "Delete Policy parameter configuration Tenant", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/policy/configuration/:policy_id/tenant/:tenant_id", "params": [ { "name": "policy_id", "value": "", "type": "path", "description": "Specify the policy id to delete policy configuration for the tanant. Policy id can be obtained from the list policy api" }, { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Delete the policy configuration parameters for a tenant level" } ] }, { "info": { "name": "Automation", "type": "folder" }, "items": [ { "info": { "name": "List Scripts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operation/automation/scripts/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "types", "value": "", "type": "query", "description": "Script types to filter. Allowed Values: chef, ansible, puppet, shell" }, { "name": "category", "value": "", "type": "query", "description": "Script types to filter. Allowed Values: Application, Languages, Database, Security, System, Web Server, Others" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "List all the scripts. Global Scripts - All user will have access to Corestack's Marketplace Scripts (Can view and execute). Account - All users under that account will have access (Can view and execute). Only Account admins can update/delete. Tenant - Users with access to the specific tenant will have access scripts (Can view and execute). Tenant admins can update/delete. Private - User who created will only have access." }, { "info": { "name": "Create Script", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operation/automation/scripts/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Creates a new script under the tenant. However the script will be accessible based on its scope. Global Scripts - All user will have access to Corestack's Marketplace Scripts (Can view and execute). Account - All users under that account will have access (Can view and execute). Only Account admins can update/delete. Tenant - Users with access to the specific tenant will have access scripts (Can view and execute). Tenant admins can update/delete. Private - User who created will only have access." }, { "info": { "name": "Execute Script", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operation/automation/scripts/:tenant_id/execute", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Execute scripts. Ansible script supports executing single script in multiple machines. Chef/Puppet/Shell executing multiple scripts against multiple target machines." }, { "info": { "name": "Describe Script Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operation/automation/scripts/:tenant_id/get/:script_job_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "script_job_id", "value": "", "type": "path", "description": "ID of the script_job. This can be fetched from listScriptJobs API/scriptExecute response" } ] }, "docs": "View script job details." }, { "info": { "name": "List Script Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operation/automation/scripts/:tenant_id/jobs/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "This API will list all script jobs initiated by the logged in user." }, { "info": { "name": "Scan Script", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operation/automation/scripts/:tenant_id/scan", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Scans a script to check if all dependencies(if any) are satisfied. This API will also return parameters available in script for chef and parameter & hosts available in the script for ansible" }, { "info": { "name": "View Template Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operation/automation/template/:tenant_id/get/:job_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "job_id", "value": "", "type": "path", "description": "ID of the template_job. This can be fetched from listTemplateJobs API response" } ] }, "docs": "View Template job details" }, { "info": { "name": "List Templates Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operation/automation/template/:tenant_id/jobs/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Jobs represent an instance of a Template or Script. Every time a Template or Script is executed, a Job is created. Jobs provide a reference of the execution, during and any time after it." }, { "info": { "name": "List Templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operation/automation/templates/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "dsl", "value": "", "type": "query", "description": "DSL types to filter templates." }, { "name": "services", "value": "", "type": "query", "description": "Services to filter templates." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "List all the Templates. Global Scope - All the users will have access to view and execute CoreStack Marketplace Templates will not have access to update/delete the templates. Account Scope - All users under account scope will have access to view and execute the templates, only Account admins can update/delete the templates. Tenant Scope - Users having access to the specific tenant can view or execute templates. Tenant admins can only have the access toupdate/delete the templates. Private Scope -" }, { "info": { "name": "Create Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operation/automation/templates/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Creates a new Template under the tenant. However the script will be accessible based on its scope. Global Templates - All user will have access to CoreStack's Marketplace Templates (Can view and execute). Account - All users under that account will have access (Can view and execute). Only Account admins can update/delete. Tenant - Users with access to the specific tenant will have access template (Can view and execute). Tenant admins can update/delete. Private - User who created will only have a" }, { "info": { "name": "Describe Script", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operation/automation/:tenant_id/scripts/:script_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "script_id", "value": "", "type": "path", "description": "ID of the script. This can be fetched from listScripts API" } ] }, "docs": "This API will provide detailed information about the script." }, { "info": { "name": "Update Script", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/operation/automation/:tenant_id/scripts/:script_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "script_id", "value": "", "type": "path", "description": "ID of the script. This can be fetched from listScripts API" } ] }, "docs": "Updates script details such as name, script path, dependencies etc.," }, { "info": { "name": "Delete Script", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/operation/automation/:tenant_id/scripts/:script_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "script_id", "value": "", "type": "path", "description": "ID of the script. This can be fetched from listScripts API" } ] }, "docs": "Deletes a script. Cannot undo this action, so be cautious when performing this operation. Use updateScript to make the script as inactive if required" }, { "info": { "name": "Describe Template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operation/automation/:tenant_id/templates/:template_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "template_id", "value": "", "type": "path", "description": "specify the template id to retrieve, which is a unique id can be obtained using list template api" } ] }, "docs": "Describe the already created Templates" }, { "info": { "name": "Update Template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/operation/automation/:tenant_id/templates/:template_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "template_id", "value": "", "type": "path", "description": "Specify the template id to update which is a unique id can be retrieved using list template api" } ] }, "docs": "Update Template details if required after creation using the api, the update by a user depends on the scope of the template created check create template docs for more details on the scope" }, { "info": { "name": "Delete Template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/operation/automation/:tenant_id/templates/:template_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "template_id", "value": "", "type": "path", "description": "Specify the template id of the template to delete, template id is unique can be obtained from the list template api" } ] }, "docs": "Delete a Template which is no more required" }, { "info": { "name": "Execute Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operation/automation/:tenant_id/templates/:template_id/execute", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "template_id", "value": "", "type": "path", "description": "Specify the template id to execute, template id can be obtained from the list template api" } ] }, "docs": "Execute template will return a unique job id the status of the template can be checked using the Job details api where you can pass the unique id generated to get the details or errors if any on execution" }, { "info": { "name": "Get Template Params", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operation/automation/:tenant_id/templates/:template_id/get_params", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "template_id", "value": "", "type": "path", "description": "Specify the template id to execute, template id can be obtained from the list template api" } ] }, "docs": "Get the parameters required to execute a template" }, { "info": { "name": "Validate Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operation/automation/:tenant_id/templates/:template_id/validate", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "template_id", "value": "", "type": "path", "description": "Specify the template id to execute, template id can be obtained from the list template api" } ] }, "docs": "Validates the Cloud Account and the input parameters provided for a template before executing the template" }, { "info": { "name": "Create Blueprints", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operations/automation/blueprints/:tenant_id/create", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "create blueprints" }, { "info": { "name": "Delete Blueprints", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/operations/automation/blueprints/:tenant_id/delete/:blueprint_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "blueprint_id", "value": "", "type": "path", "description": "Specify the blueprint Id to fetch data" } ] }, "docs": "delete blueprints" }, { "info": { "name": "View Blueprints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operations/automation/blueprints/:tenant_id/get/:blueprint_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "blueprint_id", "value": "", "type": "path", "description": "Specify the blueprint Id to fetch data" } ] }, "docs": "view blueprints" }, { "info": { "name": "List Blueprints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operations/automation/blueprints/:tenant_id/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "list blueprints" }, { "info": { "name": "Update Blueprints", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/operations/automation/blueprints/:tenant_id/update/:blueprint_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "blueprint_id", "value": "", "type": "path", "description": "Specify the blueprint Id to fetch data" } ] }, "docs": "update blueprints" }, { "info": { "name": "Create Script Schedules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operations/automation/scripts/:tenant_id/create", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "create script schedules" }, { "info": { "name": "Update Script Schedules", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/operations/automation/scripts/:tenant_id/update/:schedule_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "schedule_id", "value": "", "type": "path", "description": "Specify the schedule Id to fetch the schedule data" } ] }, "docs": "update script schedules" }, { "info": { "name": "Create Template Schedules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operations/automation/templates/:tenant_id/create", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "create template schedules" }, { "info": { "name": "Update Template Schedules", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/operations/automation/templates/:tenant_id/update/:schedule_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "schedule_id", "value": "", "type": "path", "description": "Specify the schedule Id to fetch the schedule data" } ] }, "docs": "update template schedules" }, { "info": { "name": "Delete Template and Script Schedules", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/operations/automation/:tenant_id/delete/:schedule_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "schedule_id", "value": "", "type": "path", "description": "Specify the schedule Id to fetch the schedule data" } ] }, "docs": "delete template and script schedules" }, { "info": { "name": "View Template and Script Schedules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operations/automation/:tenant_id/get/:schedule_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "schedule_id", "value": "", "type": "path", "description": "Specify the schedule Id to fetch the schedule data" } ] }, "docs": "view template and script schedules" }, { "info": { "name": "List Template and Script Schedules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operations/automation/:tenant_id/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "type", "value": "", "type": "query", "description": "Type of schedule. Choose one of the below." } ] }, "docs": "list template and script schedules" }, { "info": { "name": "Template List Batch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/operation/automation/templates/batch" }, "docs": "Batch the templates" }, { "info": { "name": "Template List", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/operation/automation/templates/list" }, "docs": "List the Templates" }, { "info": { "name": "Get Template Parameter Schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/operation/automation/:tenant_id/templates/:template_id/parameter_schema", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "template_id", "value": "", "type": "path", "description": "Specify the template id to get parameters, template id can be obtained from the list template api" } ] }, "docs": "Get the list of input and output parameters schema available in a template." }, { "info": { "name": "Validate parameters for a given template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/operation/automation/:tenant_id/templates/:template_id/validate_parameters", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "template_id", "value": "", "type": "path", "description": "Specify the template id to validate template execution parameters, template id can be obtained from the list template api" } ] }, "docs": "Validate a set of parameters for a given template" } ] }, { "info": { "name": "Operations", "type": "folder" }, "items": [ { "info": { "name": "List Operation Posture Details For Mobile Site", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operation/posture/dashboard_summary" }, "docs": "Operation posture dashboard" }, { "info": { "name": "List Operation Posture Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operation/posture/dashboard_summary/list", "params": [ { "name": "filter_by", "value": "", "type": "query", "description": "to filter data by cloud provider or cloud account wise.By default tenant wise data displayed" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "operation posture dashboard" }, { "info": { "name": "List Operation Visibility Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operation/:tenant_id/visibility/:cloud/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "cloud", "value": "", "type": "path", "description": "Specify the cloud service name to get the visibility details" }, { "name": "filter_by", "value": "", "type": "query", "description": "to filter operation data count by region, resource or zone or account" }, { "name": "visibility_by", "value": "", "type": "query", "description": "filter data by alerts or activity" }, { "name": "service_account_id", "value": "", "type": "query", "description": "filter data by cloud account.Invalid if filter by value is account" }, { "name": "view_list", "value": "", "type": "query", "description": "enable this option to list the visibility data for alerts or activity or automation failures" }, { "name": "resource", "value": "", "type": "query", "description": "to list visibility by resource. valid if view_list option is true and region/resource_group/zone should be false/empty" }, { "name": "region", "value": "", "type": "query", "description": "to list visibility by region.valid if view_list option is true and cloud is AWS and resource/resource_group/zone should be false/empty" }, { "name": "resource_group", "value": "", "type": "query", "description": "to list visibility by resource group. valid if view_list option is true and cloud is Azure and resource/region/zone should be false/empty" }, { "name": "zone", "value": "", "type": "query", "description": "to list visibility by zone.valid if view_list option is true and cloud is GCP and resource/region/resource_group should be false/empty" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "operation visibility dashboard" }, { "info": { "name": "Get Operations Resource Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operations/activity/:cloud_name/get_resource_detail", "params": [ { "name": "cloud_name", "value": "", "type": "path", "description": "Specify the cloud service name to get the resource details. Allowed Values - AWS, Azure, GCP" } ] }, "docs": "Get the resource details for the specified cloud service name" }, { "info": { "name": "List Operations Activity Details by Resource & Resource Type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operations/activity/:tenant_id/list_activity_operations", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "action", "value": "", "type": "query" }, { "name": "service", "value": "", "type": "query", "description": "Service by which the cloud accounts and their configurations are segregated." }, { "name": "resource", "value": "", "type": "query", "description": "Resource name of the corresponding cloud service. Resource can be fetched from Get Resource Detail API " }, { "name": "resource_type", "value": "", "type": "query", "description": "Resource type of the corresponding cloud service. Resource Type can be obtained from List Operation Visibility Details" } ] }, "docs": "List the operations based on resource and resource_type specified" }, { "info": { "name": "Azure Patch Management Report Trigger", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operations/azure_patch_management/report/trigger" }, "docs": "Trigger Azure Patch Management report" }, { "info": { "name": "Apply Operations Alert Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operations/monitoring_and_alerts/cloud_accounts/:tenant_id/apply_template", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Apply Template" }, { "info": { "name": "List Operations Alert Configuration by Cloud Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operations/monitoring_and_alerts/cloud_accounts/:tenant_id/list_cloud_account_configurations", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "List cloud account configurations" }, { "info": { "name": "Get Service Details For Operations Alert Configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operations/monitoring_and_alerts/cloud_accounts/:tenant_id/list_cloud_account_details", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Get Service Details" }, { "info": { "name": "View Applied Operations Alert Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operations/monitoring_and_alerts/cloud_accounts/:tenant_id/view_applied", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "View what is applied" }, { "info": { "name": "Clone Operations Alert Configuration Templates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operations/monitoring_and_alerts/monitoring_templates/:tenant_id/clone_template", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Clone Template" }, { "info": { "name": "Create Operations Alert Configuration Templates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operations/monitoring_and_alerts/monitoring_templates/:tenant_id/create_template", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Create Template" }, { "info": { "name": "Update Operations Alert Configuration Template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/operations/monitoring_and_alerts/monitoring_templates/:tenant_id/edit_template", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "monitoring_template_uri", "value": "", "type": "query", "description": "Specify the monitoring_template_uri of the template which the name to be edited" } ] }, "docs": "Edit Template" }, { "info": { "name": "Update Operations Alert Configuration Template Name", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/operations/monitoring_and_alerts/monitoring_templates/:tenant_id/edit_template_name", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "monitoring_template_uri", "value": "", "type": "query", "description": "Specify the monitoring_template_uri of the template which the name to be edited" } ] }, "docs": "Edit Template Name" }, { "info": { "name": "Set Default Options Operations Alert Configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/operations/monitoring_and_alerts/monitoring_templates/:tenant_id/enable_default_template", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Option to Set Template as Default" }, { "info": { "name": "List Operations Alert Configuration Templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/operations/monitoring_and_alerts/monitoring_templates/:tenant_id/list_alert_templates", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "List Alert templates" }, { "info": { "name": "List Operations Resource Metric Hierarchy Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operations/monitoring_and_alerts/monitoring_templates/:tenant_id/resource_metric_hierarchy_configuration", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "criticality", "value": "", "type": "query", "description": "Specify the criticality" }, { "name": "status", "value": "", "type": "query", "description": "Specify the status" }, { "name": "metric_type", "value": "", "type": "query", "description": "Specify the metric_type" } ] }, "docs": "resource metric hierarchy configuration listing" }, { "info": { "name": "View Operations Configuration Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operations/monitoring_and_alerts/monitoring_templates/:tenant_id/view_configuration", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "criticality", "value": "", "type": "query", "description": "Specify the criticality" }, { "name": "status", "value": "", "type": "query", "description": "Specify the status" }, { "name": "metric_type", "value": "", "type": "query", "description": "Specify the metric_type" } ] }, "docs": "view configuration listing" } ] }, { "info": { "name": "Reports", "type": "folder" }, "items": [ { "info": { "name": "Backup Report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operations/trend_analysis/backup" }, "docs": "Fetch the backup report based on cloud account usage" }, { "info": { "name": "Patch Compliance Report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operations/trend_analysis/patch_compliance" }, "docs": "Fetch the patch compliance report based on cloud account usage" }, { "info": { "name": "RecoveryService Report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/operations/trend_analysis/recovery_service" }, "docs": "Fetch the recovery service report based on cloud account usage" }, { "info": { "name": "SecureScore Mapping Report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/secure/:tenant_id/score", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This needs to fetch from Azure accounts." } ] }, "docs": "SecureScore Mapping Report" }, { "info": { "name": "Create pinned report", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/reports/pin/:report_id", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "Id of the report" } ] }, "docs": "Pin Report" }, { "info": { "name": "List pinned report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/reports/pinned/list" }, "docs": "List of pinned report" }, { "info": { "name": "Delete pinned report", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/reports/unpin/:report_id", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "Id of the report" } ] }, "docs": "Unpin Report" }, { "info": { "name": "Create view of the report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/reports/user_view/create" }, "docs": "Create view of the report" }, { "info": { "name": "Delete view of the report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/reports/user_view/delete" }, "docs": "Delete view of the report" }, { "info": { "name": "List of user report views", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/reports/user_view/list", "params": [ { "name": "report_id", "value": "", "type": "query" }, { "name": "view_name", "value": "", "type": "query" } ] }, "docs": "List views of the report" }, { "info": { "name": "Update view of the report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/reports/user_view/update" }, "docs": "Update view of the report" } ] }, { "info": { "name": "Recommendation", "type": "folder" }, "items": [ { "info": { "name": "Resolve Definition Recommendation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/recommendations/:definition_id/resolve", "params": [ { "name": "definition_id", "value": "", "type": "path", "description": "Specify the definition_id it will be fetched from list compliance posture DetailsForPolicies" } ] }, "docs": "Resolve definition recommendations" }, { "info": { "name": "Resolve Recommendation Action Preexecute", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/recommendations/:definition_id/resolve_preexecute", "params": [ { "name": "definition_id", "value": "", "type": "path", "description": "Specify the definition_id it will be fetched from list compliance posture DetailsForPolicies" } ] }, "docs": "Resolve recommendations" }, { "info": { "name": "List Recommendations by Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/recommendations/:tenant_id/account/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. " } ] }, "docs": "List recommendations by account" }, { "info": { "name": "List Recommendations by Category", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/recommendations/:tenant_id/category/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. " }, { "name": "classifications", "value": "", "type": "query", "description": "Specify the Category to fetch the recommendation data.Please enter comma separated values.Allowed values - Cost,Security,Access,Operation,Resource" } ] }, "docs": "list recommendations by category" }, { "info": { "name": "List Recommendations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/recommendations/:tenant_id/get/:recommendation_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. " }, { "name": "recommendation_id", "value": "", "type": "path", "description": "Specify the recommendation ID. This is a unique ID and can be retrieved using the 'List recommendations by Cloud Account' or 'List recommendations by Category' API call. " }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "resource_status", "value": "", "type": "query", "description": "Select the Status" } ] }, "docs": "List recommendations" }, { "info": { "name": "Resolve Recommendation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/recommendations/:tenant_id/resolve/:recommendation_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. " }, { "name": "recommendation_id", "value": "", "type": "path", "description": "Specify the recommendation ID. This is a unique ID and can be retrieved using the 'List recommendations by Cloud Account' or 'List recommendations by Category' API call. " } ] }, "docs": "Resolve recommendations" }, { "info": { "name": "Resolve PreExecute Recommendation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/recommendations/:tenant_id/resolve_preexecute/:recommendation_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. " }, { "name": "recommendation_id", "value": "", "type": "path", "description": "Specify the recommendation ID. This is a unique ID and can be retrieved using the 'List recommendations by Cloud Account' or 'List recommendations by Category' API call. " } ] }, "docs": "Execute resolve recommendations" }, { "info": { "name": "List Recommendations by Cloud Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/recommendations/:tenant_id/service_account/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. " }, { "name": "service_account_id", "value": "", "type": "query", "description": "Specify the Cloud Account ID. It is unique ID and can be retrieved from the List Cloud Accounts API." } ] }, "docs": "List recommendations by cloud account" }, { "info": { "name": "Get the List of Recommendation Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/recommendations/batch" }, "docs": "Fetch a List of Recommendation Details" }, { "info": { "name": "Apply all the Recommendation Exclusion Rules which are available/applicable/provided in the tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/recommendations/exclusion_rule/apply" }, "docs": "Apply all Recommendation Exclusion Rule" }, { "info": { "name": "Fetch a Recommendation Exclusion Rule Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/recommendations/exclusion_rule/batch" }, "docs": "Get Recommendation Exclusion rules" }, { "info": { "name": "Creates a Recommendation Exclusion Rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/recommendations/exclusion_rule/create" }, "docs": "Create a Recommendation Exclusion Rule" }, { "info": { "name": "Get Recommendation Exclusion Rule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/recommendations/exclusion_rule/item/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path", "description": "Specify the rule Id to get the recommendation exclusion rule data" } ] }, "docs": "Get a Particular Recommendation Exclusion Rule" }, { "info": { "name": "Update Recommendation Exclusion Rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/recommendations/exclusion_rule/item/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" } ] }, "docs": "Update Recommendation Exclusion Rule" }, { "info": { "name": "Delete Recommendation Exclusion Rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/recommendations/exclusion_rule/item/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path", "description": "Specify the rule ID of the Recommendation Exclusion Rule to be removed." } ] }, "docs": "Delete given rule ID" }, { "info": { "name": "List of Recommendation Exclusion Rules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/recommendations/exclusion_rule/list" }, "docs": "List Recommendation Exclusion rules." }, { "info": { "name": "List of Recommendations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/recommendations/list" }, "docs": "Fetch a List of Recommendation" }, { "info": { "name": "List of Resource Recommendation Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/recommendations/resources/batch" }, "docs": "List of resource recommendations details" }, { "info": { "name": "Fetch a List of Resource Recommendation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/recommendations/resources/list" }, "docs": "List of resource recommendations" } ] }, { "info": { "name": "Resource", "type": "folder" }, "items": [ { "info": { "name": "Getting the resources cloud account details based on the tenant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/resource/inventory/:tenant_id/cloud_account", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "service_name", "value": "", "type": "query", "description": "Cloud Service Name" } ] }, "docs": "Getting the resources cloud account details based on the tenant" }, { "info": { "name": "Get Inventory Count", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/resource/inventory/:tenant_id/count", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID for the inventory. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Get inventory category count based on the cloud and cloud account will list categories & Get inventory resource count based on the cloud and cloud account will list all resources with resource_category, resource_type, resource and will list only the count on number of resources available in particular category" }, { "info": { "name": "List Inventory Filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/resource/inventory/:tenant_id/filters", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID for the inventory. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "service_name", "value": "", "type": "query", "description": "Name of the cloud" } ] }, "docs": "Get all the available filters for the corresponding cloud.Listing filter attributes will help us in getting resource details with the filters listed can be applied on the resource details call and this api is only to list filtersfor ex: AWS will have regions and tags as filters available and Azure will have resource groups and tags as filters" }, { "info": { "name": "Get Resource Listing", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/resource/inventory/:tenant_id/resource_listing", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID for the Resource. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Listing the Resource details" }, { "info": { "name": "Get Inventory Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/resource/inventory/:tenant_id/resources", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID for the inventory. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Get resource details based on the cloud accounts, category, component, resource and filters can be applied based on the cloud and cloud account for ex: AWS will have regions in filters and Azure will have resource group as filters for listing resources." }, { "info": { "name": "List Resource Lock Config Rules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/resource/locks/:tenant_id/list_config_rules", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "query", "description": "to filter locks by tenant or cloud account wise" } ] }, "docs": "Resource posture dashboard" }, { "info": { "name": "Create Resource Lock Config Rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/resource/locks/:tenant_id/lock_config_rule", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Creates a new lock config rule under a CoreStack" }, { "info": { "name": "Delete Resource Lock Config Rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/resource/locks/:tenant_id/lock_config_rule", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Delete a lock config rule under a CoreStack" }, { "info": { "name": "List Resource Visibility Count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/resource/posture/account_or_tenant/visibility", "params": [ { "name": "tenant_id", "value": "", "type": "query", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "sub_category", "value": "", "type": "query", "description": "to filter resource data count by region, resource or account" }, { "name": "cloud", "value": "", "type": "query", "description": "filter data by cloud" }, { "name": "cloud_account_id", "value": "", "type": "query", "description": "filter data by cloud account.Invalid if sub_Category by value is account" } ] }, "docs": "Resource visibility dashboard" }, { "info": { "name": "List Resource Visibility Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/resource/posture/account_or_tenant/visibility/resources_without_locks_or_tags", "params": [ { "name": "tenant_id", "value": "", "type": "query", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "cloud", "value": "", "type": "query", "description": "filter data by cloud" }, { "name": "cloud_account_id", "value": "", "type": "query", "description": "filter data by cloud account" }, { "name": "filter_by", "value": "", "type": "query", "description": "to list resource data without tags, locks" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Resource Visibility dashboard" }, { "info": { "name": "List Resource Posture Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/resource/posture/list", "params": [ { "name": "sub_category", "value": "", "type": "query", "description": "to filter data by cloud provider or cloud account wise.By default tenant wise data displayed" }, { "name": "tenant_ids", "value": "", "type": "query", "description": "Specify the tenant ID as comma separated. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "service_name", "value": "", "type": "query", "description": "Select one from the supported services to display summary for that particular service" }, { "name": "search", "value": "", "type": "query", "description": "Search by account_name wise" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Resource posture dashboard" }, { "info": { "name": "List Resource Lock Config Rule Filters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/resource/:tenant_id/locks/:cloud/get_filters", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "cloud", "value": "", "type": "path" }, { "name": "tags", "value": "", "type": "query", "description": "to get tags keys of cloud account" }, { "name": "resources", "value": "", "type": "query", "description": "get resource filters of cloud account" }, { "name": "is_tag_wise", "value": "", "type": "query", "description": "get filters for tags of cloud account" }, { "name": "region", "value": "", "type": "query", "description": "to list of regions of cloud account" }, { "name": "resource_group", "value": "", "type": "query", "description": "to list resource groups of cloud account" }, { "name": "zone", "value": "", "type": "query", "description": "to list zone of cloud account" }, { "name": "applicability_by", "value": "", "type": "query", "description": "to list applicability filters of cloud account" }, { "name": "service_account_id", "value": "", "type": "query", "description": "cloud account id" }, { "name": "scope", "value": "", "type": "query", "description": "scope" } ] }, "docs": "Resource lock" }, { "info": { "name": "Disable Alert Rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/alert_actions/:service_account_id/disable", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the Service Account Id. This is a unique ID for each service account" } ] }, "docs": "Disable Alert Rule." }, { "info": { "name": "Enable Alert Rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/alert_actions/:service_account_id/enable", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the Service Account Id. This is a unique ID for each service account" } ] }, "docs": "Enable the Azure Alert Rule." }, { "info": { "name": "Retrieves resource detail view (overview and configuration)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/dashboard/detail" }, "docs": "Retrieves detail view of a single infrastructure resource including identity, lifecycle metadata, and canonical configuration." }, { "info": { "name": "Retrieves resource activity timeline or event attribute details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/dashboard/detail/activity" }, "docs": "Retrieves activity timeline or event details for a single infrastructure resource. Mode 1 (no event_ids): paginated timeline. Mode 2 (with event_ids): changed attribute details for diff." }, { "info": { "name": "List of infra resource details captured for given summary filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/dashboard/trend/list" }, "docs": "List of infra resource IDs captured for given trend summary." }, { "info": { "name": "Retrieves trend summary of infrastructure resources", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/dashboard/trend/summary" }, "docs": "Retrieves trend summary of infrastructure resources" }, { "info": { "name": "Get GCP sku details for the given resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/gcp/sku_details_for_resource" }, "docs": "Fetch sku details for the given GCP account" }, { "info": { "name": "Get ServiceResourceInventory Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/resource/inventory/item/:corestack_resource_id", "params": [ { "name": "corestack_resource_id", "value": "", "type": "path" } ] }, "docs": "Get resource details from the ServiceResourceInventory" }, { "info": { "name": "Lookup ServiceResourceInventory Service Accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/inventory/lookup" }, "docs": "List resource Service Account from ServiceResourceInventory" }, { "info": { "name": "List of Log Analytics Workspaces at Tenant Level", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/log_analytics/list_workspaces" }, "docs": "List Log Analytics Workspaces" }, { "info": { "name": "Get unit price of smallest sku for a specific region", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/smallest_sku_region" }, "docs": "Fetch unit price of smallest sku for a specific region" }, { "info": { "name": "Create Bulk Resource Tag Remediation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/tags/bulk_remediation" }, "docs": "Create Bulk Tag Remediation" }, { "info": { "name": "Return bulk Resource Tag Remediation Status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/tags/bulk_remediation_status" }, "docs": "Bulk Tag Remediation Status" }, { "info": { "name": "Create Resource Tag Remediation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/tags/remediation/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Create Tag Remediation" }, { "info": { "name": "Get unit price for list of resources", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/unit_price" }, "docs": "Fetch unit price for list of resources" }, { "info": { "name": "Batch VM Agents Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/virtual_machine_agents/batch" }, "docs": "Batch VM Agents Details." }, { "info": { "name": "List VM Agents Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/virtual_machine_agents/list" }, "docs": "List VM Agents Details." }, { "info": { "name": "Batch Service Resource Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/resource_inventory/batch" }, "docs": "Retrieve the Service Resource details for the specified ids" }, { "info": { "name": "List Service Resources", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/resource_inventory/list" }, "docs": "Retrieve the ids of service resources matching the filtering criteria" }, { "info": { "name": "Fetch all dependent resources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/resources/:inventory_id/dependent_resources", "params": [ { "name": "inventory_id", "value": "", "type": "path" } ] }, "docs": "Fetch all Dependent Resources." } ] }, { "info": { "name": "Security", "type": "folder" }, "items": [ { "info": { "name": "Get Threat by Cloud Accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/security/executive_dashboard/threats/by_cloud_accounts" }, "docs": "Security Dashboard Threats by Accounts" }, { "info": { "name": "Get Threat by Region", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/security/executive_dashboard/threats/by_region" }, "docs": "Security Dashboard Threat by Region" }, { "info": { "name": "Get Threat by Resource Category", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/security/executive_dashboard/threats/by_resource_category" }, "docs": "Security Dashboard Threat by Resource Category" }, { "info": { "name": "Get Threats by Trend", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/security/executive_dashboard/threats/trend_by_severity" }, "docs": "Security Dashboard Threats by Trend" }, { "info": { "name": "Get Config Violation by Cloud Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/security/executive_dashboard/violations/by_cloud_account" }, "docs": "Security Dashboard Violations by Cloud Accounts" }, { "info": { "name": "Get Config Violation By Region", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/security/executive_dashboard/violations/by_region" }, "docs": "Security Dashboard Violations by Region" }, { "info": { "name": "Get Config Violation by Resource Category", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/security/executive_dashboard/violations/by_resource_category" }, "docs": "Security Dashboard Violation by Resource Category" }, { "info": { "name": "Get Config Violation trend by severity", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/security/executive_dashboard/violations/trend_by_severity" }, "docs": "Security Dashboard Config Violation by Trend" }, { "info": { "name": "Get Vulnerability by Cloud Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/security/executive_dashboard/vulnerabilities/by_cloud_account" }, "docs": "SecOps Dashboard Vulnerabilities by Cloud Account" }, { "info": { "name": "Get Vulnerability by Region", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/security/executive_dashboard/vulnerabilities/by_region" }, "docs": "SecOps Dashboard Vulnerabilities by Region" }, { "info": { "name": "Get Vulnerability by Trend", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/security/executive_dashboard/vulnerabilities/trend_by_severity" }, "docs": "SecOps Dashboard Vulnerabilities by Trend" }, { "info": { "name": "List Security Vulnerability Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/security/posture/visibility/:tenant_id/get/vulnerability", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "accounts", "value": "", "type": "query", "description": "ID of the service account. This can be fetched from list cloud accounts API." }, { "name": "services", "value": "", "type": "query", "description": "Cloud service" } ] }, "docs": "Security Vulnerability for tenant or cloud account" }, { "info": { "name": "List Security Visibility Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/security/posture/visibility/:tenant_id/get/:action_name", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "action_name", "value": "", "type": "path", "description": "Action name to get visibility data" }, { "name": "accounts", "value": "", "type": "query", "description": "ID of the service account. This can be fetched from list cloud accounts API." }, { "name": "services", "value": "", "type": "query", "description": "Cloud service" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Security threat and guardrails details for tenant or cloud account" }, { "info": { "name": "Get Security Posture Details By Tenant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/security/posture/:tenant_id/get/securityops", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "category", "value": "", "type": "query", "description": "Severity of the violations." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "search", "value": "", "type": "query", "description": "search by tenant_name wise" } ] }, "docs": "Security posture By Tenant" }, { "info": { "name": "Get Security Posture Details by Cloud Account & Cloud Service Provider", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/security/posture/:tenant_id/get/securityops/:action_name", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "action_name", "value": "", "type": "path", "description": "Action name to get posture data by Cloud and Cloud Accounts category" }, { "name": "category", "value": "", "type": "query", "description": "Severity of the violations. Choose any of the below when action_name is chosen as posture_by_cloud_account" }, { "name": "service_name", "value": "", "type": "query", "description": "Select one from the supported services to display summary for that particular service" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "search", "value": "", "type": "query", "description": "Search by account_name wise" } ] }, "docs": "Security posture by Cloud and Cloud Accounts" }, { "info": { "name": "Get summary of infra mis-configurations aggregated by region, resource category, or account for a given tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/dashboard/infra_misconfig/summary" }, "docs": "Get summary of infra mis-configurations aggregated by region, resource category, or account for a given tenant." }, { "info": { "name": "Get summary of infra mis-configurations aggregated by resource(s) for a given tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/dashboard/infra_misconfig/summary_by_resource" }, "docs": "Get summary of infra mis-configurations aggregated by region, resource category, or account for a given tenant." }, { "info": { "name": "List of infra misconfigurations IDs captured for given summary filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/dashboard/infra_misconfig/trend/list" }, "docs": "List of infra misconfigurations IDs captured for given trend summary." }, { "info": { "name": "Retrieves trend summary of infrastructure misconfigurations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/dashboard/infra_misconfig/trend/summary" }, "docs": "Retrieves trend summary of infrastructure misconfigurations" }, { "info": { "name": "Get summary of infra threats aggregated by region, resource category, or account for a given tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/dashboard/infra_threats/summary" }, "docs": "Get summary of infra threats aggregated by region, resource category, or account for a given tenant." }, { "info": { "name": "Get summary of infra threats aggregated by resource(s) for a given tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/dashboard/infra_threats/summary_by_resource" }, "docs": "Get summary of infra threats aggregated by resource(s) for a given tenant" }, { "info": { "name": "List of infra threat IDs captured for given summary filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/dashboard/infra_threats/trend/list" }, "docs": "List of infra threat IDs captured for given trend summary." }, { "info": { "name": "Retrieves trend summary of infrastructure threats", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/dashboard/infra_threats/trend/summary" }, "docs": "Retrieves trend summary of infrastructure threats" }, { "info": { "name": "Get summary of infra vulnerabilities aggregated by region, resource category, or account for a given tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/dashboard/infra_vulnerabilities/summary" }, "docs": "Get summary of infra vulnerabilities aggregated by region/account/resource category for a given tenant." }, { "info": { "name": "Get summary of infra vulnerabilities aggregated by resource(s) for a given tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/dashboard/infra_vulnerabilities/summary_by_resource" }, "docs": "Get summary of infra vulnerabilities aggregated by aggregated by resource(s) for a given tenant" }, { "info": { "name": "List of infra vulnerability IDs captured for given summary filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/dashboard/infra_vulnerabilities/trend/list" }, "docs": "List of infra vulnerability IDs captured for given trend summary." }, { "info": { "name": "Retrieves trend summary of infrastructure vulnerabilities", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/dashboard/infra_vulnerabilities/trend/summary" }, "docs": "Retrieves trend summary of infrastructure vulnerabilities" }, { "info": { "name": "Details of the given batch of threat IDs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/infra_threats/batch" }, "docs": "Details of the given batch of threat IDs. Supports a maximum of 1000 IDs per request." }, { "info": { "name": "Lists of threat IDs captured for cloud resources", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/infra_threats/list" }, "docs": "List of threat IDs captured for cloud resources." }, { "info": { "name": "Details of the given batch of vulnerability IDs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/infra_vulnerabilities/batch" }, "docs": "Details of the given batch of vulnerability IDs. Supports a maximum of 1000 IDs per request." }, { "info": { "name": "List of vulnerability IDs captured for cloud resources", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/infra_vulnerabilities/list" }, "docs": "List of vulnerability IDs captured for cloud resources." }, { "info": { "name": "List Compliance summary by service accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/secops/dashboard/compliance/compliance_by_service_account" }, "docs": "Compliance summary at Service Account level" }, { "info": { "name": "List Compliance summary by tenants", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/secops/dashboard/compliance/compliance_by_tenant" }, "docs": "Compliance summary at tenant level" }, { "info": { "name": "Get Access Violation by Cloud Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/security/executive_dashboard/access/by_cloud_account" }, "docs": "Security Dashboard Access Violations by Cloud Accounts" }, { "info": { "name": "Get Access Violation By Region", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/security/executive_dashboard/access/by_region" }, "docs": "Security Dashboard Access Violations by Region" }, { "info": { "name": "Get Access Violation trend by severity", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/security/executive_dashboard/access/trend_by_severity" }, "docs": "Security Dashboard Access Violation by Trend" } ] }, { "info": { "name": "Self Service", "type": "folder" }, "items": [ { "info": { "name": "Self Service Customer Dashboard", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/self_service/dashboard/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "action", "value": "", "type": "query", "description": "Select action" } ] }, "docs": "CustomerDashboard" }, { "info": { "name": "Self Service Order History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/self_service/orders/:tenant_id/:action", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "action", "value": "", "type": "path", "description": "Select action" } ] }, "docs": "OrderHistory" }, { "info": { "name": "Create Resource Catalog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/self_service/resource_catalogs/:tenant_id/create", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Resource Catalog Create" }, { "info": { "name": "List Resource Catalog", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/self_service/resource_catalogs/:tenant_id/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Resource Catalog list" }, { "info": { "name": "Update Resource Catalog", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/self_service/resource_catalogs/:tenant_id/:catalog_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "catalog_id", "value": "", "type": "path", "description": "Catalog ID" } ] }, "docs": "Resource Catalog Modify" }, { "info": { "name": "Delete Resource Catalog", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/self_service/resource_catalogs/:tenant_id/:catalog_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "catalog_id", "value": "", "type": "path", "description": "Catalog ID" } ] }, "docs": "Resource Catalog Delete" }, { "info": { "name": "List Workspaces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/self_service/workspace/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "action", "value": "", "type": "query", "description": "Select the action" }, { "name": "type", "value": "", "type": "query", "description": "Select the request type" }, { "name": "show_failed", "value": "", "type": "query", "description": "Select to true to display false one also" } ] }, "docs": "WorkSpace" }, { "info": { "name": "Create Service Catalog", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/self_service/:tenant_id/catalog/:cloud_account_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "cloud_account_id", "value": "", "type": "path", "description": "Cloud Account ID" }, { "name": "action", "value": "", "type": "query", "description": "action" } ] }, "docs": "Get Service Catalog" }, { "info": { "name": "Delete Service Catalog", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/self_service/:tenant_id/catalog/:cloud_account_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "cloud_account_id", "value": "", "type": "path", "description": "Cloud Account ID" } ] }, "docs": "Service Catalog list" }, { "info": { "name": "View Self Service Catalog Hierarchy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/self_service/catalogs/hierarchy" }, "docs": "View Self Service Catalog Hierarchy" }, { "info": { "name": "View Self Service Request Attributes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/self_service/request/attributes" }, "docs": "View Self Service Request Attributes for Action" }, { "info": { "name": "View Self Service Request Action Attributes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/self_service/request/attributes/:action", "params": [ { "name": "action", "value": "", "type": "path", "description": "Corestack self service request action" } ] }, "docs": "View Self Service Request Action Attributes" } ] }, { "info": { "name": "Identity", "type": "folder" }, "items": [ { "info": { "name": "List Tenant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tenants" }, "docs": "There can be multiple tenants within a CoreStack account. List all tenants the user is mapped under a CoreStack account. If there are 3 tenants and user performing this operation has access to only 2 tenants then only those 2 tenants will be returned." }, { "info": { "name": "Create Tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/tenants" }, "docs": "Creates a new tenant under a CoreStack account. There can be multiple tenants within a CoreStack account." }, { "info": { "name": "Get Tenant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tenants/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Retrieve a tenant by its Id. If you're unsure of the tenant_id, use listTenant operation to list all tenants under a CoreStack account and fetch the needed tenant_id." }, { "info": { "name": "Update Tenant", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/tenants/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Id of the CoreStack account under which the tenant to be updated." } ] }, "docs": "Update a tenant's status, description & metadata using its id. No operation can be performed when a tenant is made suspended." }, { "info": { "name": "Delete Tenant", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/tenants/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Id of the tenant to be deleted." } ] }, "docs": "Delete a tenant by its Id. Cannot undo this action, so be cautious when performing this operation. Use updateTenant to make the tenant as suspended if required." }, { "info": { "name": "Get Tenant Name Change History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tenants/:tenant_id/name_change_history", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Id of the tenant to retrieve name change history for." } ] }, "docs": "Retrieve the name change history for a tenant." }, { "info": { "name": "List Roles by Tenant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tenants/:tenant_id/roles", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "This GET method is used to retrieve the list of Roles available within a specific tenant." }, { "info": { "name": "List Users by Tenant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tenants/:tenant_id/users", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "List all users within a tenant." }, { "info": { "name": "Change Password", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/users/change_password/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Update the password of the user. This password will be used for login to portal and it will not affect the Access Key / Secret Key associated with the user. Cannot update password of another user within the same CoreStack account. Can be updated for the user associated with Access Key / Secret Key" }, { "info": { "name": "Change Timezone", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/users/change_time_zone/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Update the timezone settings of the user. In CoreStack portal, wherever the datatime is shown it is converted to the timezone set to the user. Cannot update timezone of another user within the same CoreStack account. Can be updated for the user associated with Access Key / Secret Key" }, { "info": { "name": "Create User", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/create" }, "docs": "Creates an user within a CoreStack account and assign different roles for different tenants. There can be multiple tenants within a CoreStack account. User will be created at the account level and mapped to multiple tenants as needed." }, { "info": { "name": "Delete User", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/delete/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Deletes the User from CoreStack system. This operation cannot be undone." }, { "info": { "name": "List Users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/filter-options" }, "docs": "List all tenants, cloud providers and cloud accounts available within a CoreStack account." }, { "info": { "name": "List Users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/filter-options-light" }, "docs": "List all tenants with limited details within a CoreStack account." }, { "info": { "name": "Forget Password", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/forget_password/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "User Id fetched from List User API" } ] }, "docs": "Forget the password of the user. This password will be used for login to portal and it will not affect the Access Key / Secret Key associated with the user" }, { "info": { "name": "List Users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/list", "params": [ { "name": "master_account_id", "value": "", "type": "query", "description": "Specify the master account id" } ] }, "docs": "List all users within a CoreStack account." }, { "info": { "name": "Send notification report email", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/notification/report" }, "docs": "Send a notification email for a shared report" }, { "info": { "name": "Check notification status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/notifications/:user_id/:tenant_id", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "Id of user" }, { "name": "tenant_id", "value": "", "type": "path", "description": "Id of active tenant" } ] }, "docs": "Check Notification status for user" }, { "info": { "name": "Update active tenant for a user", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/users/profile/active-tenant" }, "docs": "Sets the active tenant for the user" }, { "info": { "name": "View User Profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/profile/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "User Id fetched from List User API" } ] }, "docs": "Describes an User by ID. This provides detailed information about a user profile" }, { "info": { "name": "Resend User Token for Activation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/resend_token/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "Id of user" } ] }, "docs": "Resend User Activation Link" }, { "info": { "name": "Reset Password", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/reset_password" }, "docs": "Reset the password of the user.This password will be used for login to portal and it will not affect the Access Key / Secret Key associated with the user" }, { "info": { "name": "User Batch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/summary/batch" }, "docs": "User Summary Batch" }, { "info": { "name": "Update User", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/users/update/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Updates a user and their role assignment in multiple tenants." }, { "info": { "name": "Describe User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/view/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Describes an User by ID. This provides detailed information about a user" }, { "info": { "name": "List notification message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:tenant_id/notification_message", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "action", "value": "", "type": "query", "description": "Specify the action name. Allowed values: view_notifications, if require to fetch data with filter wise use view_notifications" }, { "name": "display", "value": "", "type": "query", "description": "Specify value for display, if require to fetch data for filter wise use read, unread,all" } ] }, "docs": "This GET method is used to retrieve the Notification, Message a specific tenant." }, { "info": { "name": "Activate User", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:user_id/activate_user/:auth_token", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "Id of user" }, { "name": "auth_token", "value": "", "type": "path", "description": "auth_token to activate created user.Can be fetched from the activation email sent" } ] }, "docs": "Activate user using auth token" }, { "info": { "name": "Verify User", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:user_id/verify_user/:auth_token", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "Id of user" }, { "name": "auth_token", "value": "", "type": "path", "description": "auth_token to verify created user.Can be fetched from the activation email sent" } ] }, "docs": "Verify user using auth token" }, { "info": { "name": "List Roles by Master Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/master_accounts/:master_account_id/roles", "params": [ { "name": "master_account_id", "value": "", "type": "path", "description": "Specify the master account ID" } ] }, "docs": "Role List By Master Account" }, { "info": { "name": "Tenant List by Master Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/master_accounts/:master_account_id/tenants", "params": [ { "name": "master_account_id", "value": "", "type": "path" } ] }, "docs": "Tenant List by Master Account" }, { "info": { "name": "Role Batch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/roles/summary/batch" }, "docs": "Role Batch" }, { "info": { "name": "Auth0 User Verification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/user/verify/:access_key", "params": [ { "name": "access_key", "value": "", "type": "path" } ] }, "docs": "User Verify" }, { "info": { "name": "Reset Password for Auth0 User", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/user/:user_id/password_reset", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Reset Password for the Auth0 User" }, { "info": { "name": "Create User Delegation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/user_delegation/master_accounts/:master_account_id/rules", "params": [ { "name": "master_account_id", "value": "", "type": "path" } ] }, "docs": "Creates a new user delegation" }, { "info": { "name": "Batch User Delegation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/user_delegation/master_accounts/:master_account_id/rules/batch", "params": [ { "name": "master_account_id", "value": "", "type": "path" } ] }, "docs": "Batch User Delegation" }, { "info": { "name": "Update User Delegation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/user_delegation/master_accounts/:master_account_id/rules/item/:rule_id", "params": [ { "name": "master_account_id", "value": "", "type": "path" }, { "name": "rule_id", "value": "", "type": "path" } ] }, "docs": "Update user delegation" }, { "info": { "name": "Delete User Delegation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/user_delegation/master_accounts/:master_account_id/rules/item/:rule_id", "params": [ { "name": "master_account_id", "value": "", "type": "path" }, { "name": "rule_id", "value": "", "type": "path" } ] }, "docs": "Delete user delegation" }, { "info": { "name": "List User Delegation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/user_delegation/master_accounts/:master_account_id/rules/list", "params": [ { "name": "master_account_id", "value": "", "type": "path" } ] }, "docs": "List user delegation" }, { "info": { "name": "Refresh User Delegation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/user_delegation/master_accounts/:master_account_id/rules/refresh", "params": [ { "name": "master_account_id", "value": "", "type": "path" } ] }, "docs": "Refresh User Delegation" }, { "info": { "name": "Get User Delegation Report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/user_delegation/report/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Get user delegation report" }, { "info": { "name": "Invite User", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/users/invite" }, "docs": "Invite user" } ] }, { "info": { "name": "Background Jobs", "type": "folder" }, "items": [ { "info": { "name": "Sets the next activation time for the Background Job", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/admin/background_job/activation" }, "docs": "Changes the activation of a Background Job" }, { "info": { "name": "Returns a batch of BackgroundJobs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/background_job/batch" }, "docs": "Get details for the Background Job ids passed in the request" }, { "info": { "name": "Requests the cancellation of a job", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/admin/background_job/cancel" }, "docs": "Request a Background Job to stop processing as soon as possible" }, { "info": { "name": "Internal", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/background_job/forwarding_check" }, "docs": "Verify federation route" }, { "info": { "name": "BackgroundJobInvalidation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/admin/background_job/invalidation" }, "docs": "Request a Background Job to stop processing as soon as possible" }, { "info": { "name": "Returns a list of BackgroundJobs ids", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/background_job/list" }, "docs": "Get the list of all Background Jobs." }, { "info": { "name": "Returns a batch of log entries for BackgroundJob", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/background_job/log" }, "docs": "Get log entries for the Background Job passed in the request" }, { "info": { "name": "Sets the level of a logger", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/background_job/logger/set-level" }, "docs": "Set the level of a logger for Background Jobs workers." }, { "info": { "name": "Returns a list of BackgroundJobs threads", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/background_job/loggers" }, "docs": "Get loggers from all Background Jobs workers." }, { "info": { "name": "Sets the priority on Background Job", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/admin/background_job/priority" }, "docs": "Changes the priority of a Background Job" }, { "info": { "name": "Queues a Background Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/background_job/queue" }, "docs": "Queue a Background Job" }, { "info": { "name": "Returns the frames for the executing BackgroundJob", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/background_job/stacktrace" }, "docs": "Get the stack trace for the executing Background Job passed in the request" }, { "info": { "name": "Returns statistics about the selected executors", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/background_job/stats" }, "docs": "Get statistics from all Background Jobs workers." }, { "info": { "name": "Returns a list of BackgroundJobs threads", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/background_job/threads" }, "docs": "Get threads from all Background Jobs workers." }, { "info": { "name": "Fetch the configuration of a Background Job Handler", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/background_job_handler/configuration" }, "docs": "Request the configuration for a Background Job Handler" }, { "info": { "name": "Update the configuration of a Background Job Handler", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/background_job_handler/configuration" }, "docs": "Update the configuration for a Background Job Handler" }, { "info": { "name": "Lists the active Background Job Handlers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/background_job_handler/list" }, "docs": "List the active Background Job Handlers" } ] }, { "info": { "name": "Request Audit", "type": "folder" }, "items": [ { "info": { "name": "Returns a batch of RequestAuditEntries", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/request_audit/batch" }, "docs": "Get details for the request audit ids passed in the request" }, { "info": { "name": "Clears the caching layer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/request_audit/cache/flush" }, "docs": "Clears caching layer" }, { "info": { "name": "Returns a list of endpoints active in the target executor", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/request_audit/describe" }, "docs": "Describe active endpoints" }, { "info": { "name": "Returns a list of BackgroundJobs ids", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/request_audit/list" }, "docs": "Filter request audits" }, { "info": { "name": "Streams the profiler's result for a request audit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/admin/request_audit/profile/:request_audit_id", "params": [ { "name": "request_audit_id", "value": "", "type": "path" } ] }, "docs": "Download a profile results" }, { "info": { "name": "Configures the parameters for auto triggering the collection of profiling data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/request_audit/profiler/auto_trigger" }, "docs": "Configure profiling auto trigger" }, { "info": { "name": "Requests to profile a endpoint or resource path", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/request_audit/profiler/config" }, "docs": "Requests to profile endpoints" }, { "info": { "name": "Get the list of endpoints currently profiled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/request_audit/profiler/status" }, "docs": "Lists currently profiled endpoints" }, { "info": { "name": "Returns hit counts for an endpoint or path in the target executor", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/request_audit/statistics" }, "docs": "Reports usage statistics for an endpoint or path" } ] }, { "info": { "name": "AI Agent", "type": "folder" }, "items": [ { "info": { "name": "Confirm or deny a pending agent action", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/action/confirm" }, "docs": "Confirm or deny a pending agent action. On confirm, the agent executes the action (workload creation, policy execution, etc.). On deny, the action is cancelled with no execution." }, { "info": { "name": "Batch Chat Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/chat/batch" }, "docs": "Retrieve the chat details for the specified ids" }, { "info": { "name": "Update the conversation of the chat", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/chat/conversations/item/:conversation_id", "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "Specify the conversation ID to read, ID which can be obtained from the conversations API." } ] }, "docs": "Update the conversation of the chat." }, { "info": { "name": "Create a new chat", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/chat/create" }, "docs": "Create a new Chat" }, { "info": { "name": "Delete the Chat and the conversations associated with it", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/chat/delete" }, "docs": "Delete the chat for the specified ids" }, { "info": { "name": "Get chat details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/agent/chat/item/:chat_id", "params": [ { "name": "chat_id", "value": "", "type": "path", "description": "Specify the chat ID to read, ID which can be obtained from the list chats API." } ] }, "docs": "Retrieve the current details of the chat." }, { "info": { "name": "Update the details of the chat", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/chat/item/:chat_id", "params": [ { "name": "chat_id", "value": "", "type": "path", "description": "Specify the chat ID to read, ID which can be obtained from the list chats API." } ] }, "docs": "Update the details of the chat." }, { "info": { "name": "ListChatSuggestions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/agent/chat/item/:chat_id/suggestions", "params": [ { "name": "chat_id", "value": "", "type": "path" } ] }, "docs": "Get the chat suggestions" }, { "info": { "name": "List chats", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/chat/list" }, "docs": "Retrieve the ids of chats matching the filtering criteria" }, { "info": { "name": "Batch conversations Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/conversations/batch" }, "docs": "Retrieve the conversations details for the specified ids" }, { "info": { "name": "Interrupt the processing conversation of the chat", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/conversations/item/:conversation_id/interrupt", "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "Specify the conversation ID to read, ID which can be obtained from the conversations API." } ] }, "docs": "Interrupt the processing conversation of the chat." }, { "info": { "name": "Stream the conversation response for the specified conversation ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/agent/conversations/item/:conversation_id/stream", "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "Specify the conversation ID to read, ID which can be obtained from the conversations API." } ] }, "docs": "Stream the conversation response for the specified conversation ID using Server-Sent Events (SSE).\nReturns an SSE stream with real-time data chunks." }, { "info": { "name": "Retrieves the conversations for the specified chat based on the given filter", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/conversations/list" }, "docs": "Fetch the conversations for the specified chat based on the given filter." }, { "info": { "name": "Submit a new query for the specific agent and retrieve the agent's response for the given feed query", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/feed" }, "docs": "Submit a new query for the specific agent and retrieve the agent's response for the given feed query." }, { "info": { "name": "Retrieve the saved prompt details for the specified ids", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/prompt/batch" }, "docs": "Retrieve the saved prompt details for the specified ids" }, { "info": { "name": "List the filters for the specified agent id and prompt type", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/prompt/filters" }, "docs": "Retrieve the filters for the specified agent id and prompt type." }, { "info": { "name": "Delete a particular custom prompt", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/agent/prompt/item/:prompt_id", "params": [ { "name": "prompt_id", "value": "", "type": "path", "description": "Specify the prompt ID to read, ID which can be obtained from the list prompts API." } ] }, "docs": "Delete the custom prompt." }, { "info": { "name": "List saved prompts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/prompt/list" }, "docs": "Retrieve the ids of saved prompts matching the filtering criteria" }, { "info": { "name": "Saves the prompt", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/prompt/save" }, "docs": "Saves the prompt." }, { "info": { "name": "Submit a new query for the specified chat and retrieve the agent's response", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/query" }, "docs": "Submit a new query for the specified chat and retrieve the agent's response." }, { "info": { "name": "Schedule the generation of a report for Ai agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agent/report/generate" }, "docs": "Generate a report for an Ai agent" }, { "info": { "name": "Fetch an Ai agent report by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/agent/report/item/:report_id", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "ID of the report to fetch. This can be retrieved using Report Generation API." } ] }, "docs": "Get a report for an agent." }, { "info": { "name": "List the available agents types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/agent/types" }, "docs": "List of Agent types." }, { "info": { "name": "Get MCP server details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/mcp/server/item/:server_id", "params": [ { "name": "server_id", "value": "", "type": "path", "description": "MCP server ID returned from the register API." } ] }, "docs": "Retrieve details of a specific MCP server." }, { "info": { "name": "Update an MCP server's configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/mcp/server/item/:server_id", "params": [ { "name": "server_id", "value": "", "type": "path", "description": "MCP server ID returned from the register API." } ] }, "docs": "Update a registered MCP server." }, { "info": { "name": "Delete MCP server", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/mcp/server/item/:server_id", "params": [ { "name": "server_id", "value": "", "type": "path", "description": "MCP server ID returned from the register API." } ] }, "docs": "Delete a registered MCP server." }, { "info": { "name": "Enable or disable an MCP server post-registration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/mcp/server/item/:server_id/enabled", "params": [ { "name": "server_id", "value": "", "type": "path", "description": "MCP server ID returned from the register API." } ] }, "docs": "Enable or disable a registered MCP server without modifying its configuration." }, { "info": { "name": "List MCP servers for the current tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/mcp/server/list" }, "docs": "List all MCP servers registered for the current tenant." }, { "info": { "name": "Register a new MCP server for the current tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/mcp/server/register" }, "docs": "Register a new MCP server for the tenant." }, { "info": { "name": "Get MCP tools available for a tenant and business agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/mcp/server/tools" }, "docs": "Retrieve MCP tool metadata scoped by tenant and business agent." } ] }, { "info": { "name": "AIGovernance", "type": "folder" }, "items": [ { "info": { "name": "Aggregate AI Metrics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/ai_governance/metrics/aggregate" }, "docs": "Retrieve aggregated AI metrics for the specified filters and date range" } ] }, { "info": { "name": "Application Health", "type": "folder" }, "items": [ { "info": { "name": "BatchApplicationHealthDetails", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/application_health/batch" }, "docs": "Batch Application Health Details." }, { "info": { "name": "ListApplicationHealth", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/application_health/list" }, "docs": "Retrieve the list of Application Health." }, { "info": { "name": "MetricResourceUtilization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/monitoring/resource_utilization" }, "docs": "Metric Resource Utilization Details." } ] }, { "info": { "name": "AppSecOps", "type": "folder" }, "items": [ { "info": { "name": "List of application details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/applications/batch" }, "docs": "Details of the given batch of application IDs. Supports a maximum of 1000 IDs per request." }, { "info": { "name": "Creates an application", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/applications/create" }, "docs": "Creates an application" }, { "info": { "name": "Get the application details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/appsecops/applications/item/:application_id", "params": [ { "name": "application_id", "value": "", "type": "path", "description": "Specify the application ID to get the application data" } ] }, "docs": "Get details of a given application." }, { "info": { "name": "Update an application", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/applications/item/:application_id", "params": [ { "name": "application_id", "value": "", "type": "path", "description": "Specify the application ID to update the application data" } ] }, "docs": "Update details of the given application." }, { "info": { "name": "List of Applications", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/applications/list" }, "docs": "List of applications" }, { "info": { "name": "Create a new BCS answer version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/bcs_questions/answers_version/create" }, "docs": "Create a new BCS answer version" }, { "info": { "name": "Paginated history of BCS answer versions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/bcs_questions/answers_version/history" }, "docs": "Paginated history of BCS answer versions" }, { "info": { "name": "List of BCS questions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/appsecops/bcs_questions/list" }, "docs": "List of BCS questions" }, { "info": { "name": "List of container finding details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/container/findings/batch" }, "docs": "Details of the given batch of container finding IDs. Supports a maximum of 1000 IDs per request." }, { "info": { "name": "Ingest container security findings from external tools", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/container/findings/ingest" }, "docs": "Ingest container security findings from tools like Dockle and Hadolint" }, { "info": { "name": "List of container security findings with filtering and pagination support", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/container/findings/list" }, "docs": "List of container security findings with filtering and pagination support" }, { "info": { "name": "List all Portfolios along with its associated applications and projects", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/dashboard/summary/portfolio_hierarchy" }, "docs": "List of portfolio details and associated applications and projects" }, { "info": { "name": "List of all SBOMs along with its associated components", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/dashboard/summary/sbom_components" }, "docs": "List of SBOM details along with associated components" }, { "info": { "name": "List of all SBOM vulnerabilities", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/dashboard/summary/sbom_vulnerabilities" }, "docs": "List of SBOM vulnerabilities" }, { "info": { "name": "Summary of differences in vulnerability and component counts compared to the previous SBOM build", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/dashboard/summary/version_diff" }, "docs": "Retrieve the difference in vulnerability and component counts compared to the previous SBOM build." }, { "info": { "name": "List top (x) actionable issues including vulnerabilities, threats and config violations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/dashboard/top_actionable_issues" }, "docs": "List Top actionable issues including vulnerabilities, threats and config violations" }, { "info": { "name": "List of aggregated vulnerability count by component properties", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/dashboard/vulnerabilities/aggregation_by_component" }, "docs": "Aggregated vulnerability count by component properties" }, { "info": { "name": "List of vulnerabilities count by severity", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/dashboard/vulnerabilities/trend_by_severity" }, "docs": "List of vulnerabilities count by severity" }, { "info": { "name": "List of portfolio details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/portfolios/batch" }, "docs": "Details of the given batch of portfolio IDs. Supports a maximum of 1000 IDs per request." }, { "info": { "name": "Creates a portfolio", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/portfolios/create" }, "docs": "Creates a portfolio" }, { "info": { "name": "Get the portfolio details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/appsecops/portfolios/item/:portfolio_id", "params": [ { "name": "portfolio_id", "value": "", "type": "path", "description": "Specify the portfolio ID to get the portfolio data" } ] }, "docs": "Get details of a given portfolio." }, { "info": { "name": "Update the portfolio details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/portfolios/item/:portfolio_id", "params": [ { "name": "portfolio_id", "value": "", "type": "path", "description": "Specify the portfolio Id to update the portfolio data" } ] }, "docs": "Updates the given portfolio details." }, { "info": { "name": "List of portfolios", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/portfolios/list" }, "docs": "List of portfolios" }, { "info": { "name": "List of project details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/projects/batch" }, "docs": "Details of the given batch of project IDs. Supports a maximum of 1000 IDs per request." }, { "info": { "name": "Creates a project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/projects/create" }, "docs": "Creates a project" }, { "info": { "name": "Get the project details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/appsecops/projects/item/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Specify the project ID to get the project data" } ] }, "docs": "Get details for given project ID" }, { "info": { "name": "Update the project details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/projects/item/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Specify the project ID to update the project data" } ] }, "docs": "Update the project details for given project ID" }, { "info": { "name": "List of projects", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/projects/list" }, "docs": "List of projects" }, { "info": { "name": "List of sbom component details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/sbom_components/batch" }, "docs": "Details of the given batch of SBOM component IDs. Supports a maximum of 1000 IDs per request." }, { "info": { "name": "List of SBOM definition details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/sbom_definition/batch" }, "docs": "Details of the given batch of SBOM definition IDs. Supports a maximum of 1000 IDs per request." }, { "info": { "name": "Creates a SBOM definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/sbom_definition/create" }, "docs": "Create a SBOM definition" }, { "info": { "name": "Get SBOM definition details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/appsecops/sbom_definition/item/:sbom_id", "params": [ { "name": "sbom_id", "value": "", "type": "path", "description": "Specify the SBOM definition ID to get the SBOM definition data" } ] }, "docs": "Get a particular SBOM definition details for given SBOM definition ID" }, { "info": { "name": "Update SBOM definition details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/sbom_definition/item/:sbom_id", "params": [ { "name": "sbom_id", "value": "", "type": "path", "description": "Specify the SBOM definition ID to update the SBOM definition data" } ] }, "docs": "Update the SBOM definition details for given SBOM definition ID" }, { "info": { "name": "List of versions for a SBOM definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/appsecops/sbom_definition/item/:sbom_id/list_version", "params": [ { "name": "sbom_id", "value": "", "type": "path" } ] }, "docs": "List of SBOM versions for a given SBOM definition ID" }, { "info": { "name": "List of SBOM definitions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/sbom_definition/list" }, "docs": "List of SBOM definitions" }, { "info": { "name": "List of SBOM version details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/sbom_version/batch" }, "docs": "Details of the given batch of SBOM version IDs. Supports a maximum of 1000 IDs per request." }, { "info": { "name": "Creates a SBOM Version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/sbom_version/create" }, "docs": "Create a SBOM Version" }, { "info": { "name": "List of SBOM version difference details between the given SBOM version IDs and its corresponding predecessor version IDs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/sbom_version/diff/batch" }, "docs": "List of SBOM version difference details for the given SBOM version IDs and predecessor version ID. Supports a maximum of 1000 IDs per request." }, { "info": { "name": "Get SBOM version details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/appsecops/sbom_version/item/:version_id", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "Specify the SBOM version ID to get the SBOM version data" } ] }, "docs": "Get a particular SBOM version for given SBOM version ID" }, { "info": { "name": "Update SBOM version details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/sbom_version/item/:version_id", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "Specify the SBOM version ID to update the SBOM version data" } ] }, "docs": "Update SBOM version details (Build ID) for given SBOM Version ID" }, { "info": { "name": "Delete SBOM version", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/appsecops/sbom_version/item/:version_id", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "Specify the SBOM version ID to remove the SBOM version data" } ] }, "docs": "Deletes given SBOM version" }, { "info": { "name": "Fetch SBOM version component and vulnerability difference details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/sbom_version/item/:version_id/diff", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "Specify the SBOM version ID which is the base version to fetch the build difference" } ] }, "docs": "Retrieve the difference in vulnerability and component IDs compared from the given SBOM version to requested SBOM version. If compare version ID is not passed, fetch for previous SBOM version" }, { "info": { "name": "Make SBOM version as the Release version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/appsecops/sbom_version/item/:version_id/make-release", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "Specify the SBOM version ID to mark this version as the release version" } ] }, "docs": "Mark this version as the release version" }, { "info": { "name": "List of SBOM version vulnerabilities details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/sbom_version/vulnerabilities/batch" }, "docs": "Vulnerabilities details of the given batch of SBOM version Vulnerability ID(s). SBOM version vulnerability IDs can be obtained from the List SBOM Vulnerabilities API. Supports a maximum of 1000 IDs per request." }, { "info": { "name": "List of organization(s) details where the vulnerabilities are prevalent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/appsecops/vulnerabilities/prevalence/organization" }, "docs": "List of Organizational entities (portfolio, application and project) where the provided vulnerability is prevalent" }, { "info": { "name": "List of vulnerability details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/secops/vulnerabilities/batch" }, "docs": "Details of the given batch of vulnerability IDs. Supports a maximum of 1000 IDs per request." }, { "info": { "name": "Create an application with BCS scoring", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/appsecops/applications/create" }, "docs": "Create an application with BCS scoring" }, { "info": { "name": "Get application details with BCS scoring", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/appsecops/applications/item/:application_id", "params": [ { "name": "application_id", "value": "", "type": "path" } ] }, "docs": "Get application details with BCS scoring" }, { "info": { "name": "Update application with BCS scoring", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/appsecops/applications/item/:application_id", "params": [ { "name": "application_id", "value": "", "type": "path" } ] }, "docs": "Update application with BCS scoring" } ] }, { "info": { "name": "Attachments", "type": "folder" }, "items": [ { "info": { "name": "Get Attachments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/attachment/batch" }, "docs": "Fetch a batch of Attachments" }, { "info": { "name": "Create new Attachment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/attachment/create" }, "docs": "Create a new Attachment" }, { "info": { "name": "Get an Attachment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/attachment/item/:attachment_id", "params": [ { "name": "attachment_id", "value": "", "type": "path" } ] }, "docs": "Get an Attachment" }, { "info": { "name": "Update an Attachment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/attachment/item/:attachment_id", "params": [ { "name": "attachment_id", "value": "", "type": "path" } ] }, "docs": "Update an Attachment" }, { "info": { "name": "Upload an Attachment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/attachment/item/:attachment_id/stream", "params": [ { "name": "attachment_id", "value": "", "type": "path" } ] }, "docs": "Upload an Attachment" }, { "info": { "name": "Download an Attachment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/attachment/item/:attachment_id/stream/:file_name", "params": [ { "name": "attachment_id", "value": "", "type": "path" }, { "name": "file_name", "value": "", "type": "path" } ] }, "docs": "Download an Attachment" } ] }, { "info": { "name": "Authorization", "type": "folder" }, "items": [ { "info": { "name": "Get Access Token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/auth/tokens" }, "docs": "CoreStack requires Auth token to be passed in all the API headers. Auth token has to be generated and it is valid only for an hour. New token can be generated using this API. Extract Auth-token, Tenant Id & Account Id from the response. This will be required in most of the API calls" }, { "info": { "name": "Get Refresh Token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/auth/tokens/refresh" }, "docs": "Token generated in authToken API will be valid for an hour. Post that access_token will automatically expire. When the access_token is expired, there are two options. 1) use the authToken API to generate a new token 2) use refreshToken API to extend the validity of the current token.The refreshed token will also expire after an hour, refer to expires_at in the response for the validity of the token. When the refreshed token also expires, call again the refreshToken API to extend it further. Like" }, { "info": { "name": "Returns SSO Redirected url", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/sso_auth/tokens/:sso_name", "params": [ { "name": "sso_name", "value": "", "type": "path" } ] }, "docs": "SSO Redirected url" }, { "info": { "name": "Switch Master Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/user/switch_account/:master_account_id", "params": [ { "name": "master_account_id", "value": "", "type": "path", "description": "Specify the Master Account ID ,That you want to Switch." } ] }, "docs": "Switching Master AccountsAuth token has to be generated and it is valid only for an hour. New token can be generated using this API. Extract Auth-token." }, { "info": { "name": "Get User session and roles details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/user_details" }, "docs": "User access details provided a valid token 1) use the authToken API to generate a new token The refreshed token will also expire after an hour, refer to expires_at in the response for the validity of the token. When the refreshed token also expires, call again the refreshToken API to extend it further. Like wise a token can extended 3 times, refer to refresh_count in the response. After 3 refresh attempts, token will expire and cannot be extended any further. Need to use authToken API to generat" } ] }, { "info": { "name": "Automation WorkFlows", "type": "folder" }, "items": [ { "info": { "name": "Batch Workflows", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/automation_workflows/batch" }, "docs": "Retrieve the WorkFlow details for the specified ids" }, { "info": { "name": "Create a workflow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/automation_workflows/create" }, "docs": "Create WorkFlow." }, { "info": { "name": "Get a Workflow", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/automation_workflows/item/:definition_id", "params": [ { "name": "definition_id", "value": "", "type": "path" } ] }, "docs": "Get WorkFlow." }, { "info": { "name": "update a workflow", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/automation_workflows/item/:definition_id", "params": [ { "name": "definition_id", "value": "", "type": "path" } ] }, "docs": "Update WorkFlow." }, { "info": { "name": "Delete a Workflow", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/automation_workflows/item/:definition_id", "params": [ { "name": "definition_id", "value": "", "type": "path" } ] }, "docs": "DeleteWorkFlow." }, { "info": { "name": "List WorkFlows", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/automation_workflows/list" }, "docs": "Retrieve the ids of workflows matching the criteria" }, { "info": { "name": "List the master rules for a workflow configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/automation_workflows/list_master_rules" }, "docs": "List the master rules for a WorkFlow configurations" } ] }, { "info": { "name": "AWS Security Hub", "type": "folder" }, "items": [ { "info": { "name": "Returns a batch of Findings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/aws-security-hub/dashboard/findings/batch" }, "docs": "Get AWS Security hub findings for all ids passed in the request." }, { "info": { "name": "Returns a list AWS Security Hub Findings ids", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/aws-security-hub/dashboard/findings/list" }, "docs": "List AWS Security Hub Finding Ids" }, { "info": { "name": "Returns list of AWS securityhub finding product names with all possible filter values for the given tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/aws-security-hub/findings/filters/product_name" }, "docs": "Fetch all the product names filter values for the given tenant id" }, { "info": { "name": "Returns list of AWS securityhub finding record state with all possible filter values for the given tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/aws-security-hub/findings/filters/record_state" }, "docs": "Fetch all the record state filter values for the given tenant id" }, { "info": { "name": "Returns list of AWS securityhub finding Region with all possible filter values for the given cloud accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/aws-security-hub/findings/filters/region" }, "docs": "Fetch all the region filter values for the given tenant id" }, { "info": { "name": "Returns list of AWS securityhub finding resource with all possible filter values for the given tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/aws-security-hub/findings/filters/resource" }, "docs": "Fetch all the region filter values for the given tenant id" }, { "info": { "name": "Returns list of AWS securityhub finding severity with all possible filter values for the given tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/aws-security-hub/findings/filters/severity" }, "docs": "Fetch all the severity filter values for the given tenant id" }, { "info": { "name": "Get AWS Security Hub Region Validation Results", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/aws-security-hub/:cloud_account_id/region_details", "params": [ { "name": "cloud_account_id", "value": "", "type": "path" } ] }, "docs": "Get AWS SecurityHub Region Results" } ] }, { "info": { "name": "Azure DevOps Pipeline DashBoard", "type": "folder" }, "items": [ { "info": { "name": "List the available logs associated with build in AzureDevops", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/azure-devops/dashboard/buildlogs/list" }, "docs": "List the available logs associated with build in AzureDevops" }, { "info": { "name": "List the available builds under pipelines in AzureDevops", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/azure-devops/dashboard/builds/list" }, "docs": "List the available builds under pipelines in AzureDevops" }, { "info": { "name": "List the available workitems associated with build in AzureDevops", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/azure-devops/dashboard/buildworkitems/list" }, "docs": "List the available workitems associated with build in AzureDevops" }, { "info": { "name": "List the available projects under account in AzureDevops", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/azure-devops/dashboard/pipelines/list" }, "docs": "List the available projects under account in AzureDevops" }, { "info": { "name": "List the available project under AzureDevops", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/azure-devops/dashboard/projects/list" }, "docs": "List the available projects under account in AzureDevops" } ] }, { "info": { "name": "Billing Commitment", "type": "folder" }, "items": [ { "info": { "name": "Get billing commitment details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/billing/commitment" }, "docs": "Retrieve billing commitment details for Azure, supported only for EA account types." }, { "info": { "name": "List all billing commitment events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/billing/commitment/events" }, "docs": "List all billing commitment events for the cloud account, supported only for Azure EA account types." } ] }, { "info": { "name": "MasterAccount Billing", "type": "folder" }, "items": [ { "info": { "name": "Master Account Billing Summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/billing/master_account/:master_account_id/summary", "params": [ { "name": "master_account_id", "value": "", "type": "path" } ] }, "docs": "Billing summary of the master account" }, { "info": { "name": "Record a transaction and Update the balance for the master account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/billing/master_account/:master_account_id/transaction", "params": [ { "name": "master_account_id", "value": "", "type": "path" } ] }, "docs": "Update the balance for the master account" }, { "info": { "name": "Master Account Billing Balance Validate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/billing/master_account/:master_account_id/validate_balance", "params": [ { "name": "master_account_id", "value": "", "type": "path" } ] }, "docs": "Validate Billing Balance of the master account" }, { "info": { "name": "Batch billing transactions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/billing/transaction/batch" }, "docs": "List all billing transactions batches" }, { "info": { "name": "List billing transactions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/billing/transaction/list" }, "docs": "List all Billing Transactions" } ] }, { "info": { "name": "BillingPlanDefinitions", "type": "folder" }, "items": [ { "info": { "name": "Fetch all Billing Plan definitions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/billing_plans/batch" }, "docs": "Fetch all Billing Plan definitions" }, { "info": { "name": "Create a new Billing Plan definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/billing_plans/create" }, "docs": "Create a new Billing Plan definition" }, { "info": { "name": "Fetch all Billing Plan definitions for the user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/billing_plans/list" }, "docs": "Fetch all Billing Plan definitions for the user" }, { "info": { "name": "Get Billing Plan definition by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/billing_plans/:plan_definition_id", "params": [ { "name": "plan_definition_id", "value": "", "type": "path", "description": "The Billing Plan definition ID" } ] }, "docs": "Get Billing Plan definition by id" }, { "info": { "name": "Delete Billing Plan by plan_id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/billing_plans/:plan_definition_id", "params": [ { "name": "plan_definition_id", "value": "", "type": "path", "description": "The Billing Plan definition ID" } ] }, "docs": "Delete Billing Plan by plan_id" }, { "info": { "name": "Get Billing Plan definition history by definition id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/billing_plans/:plan_definition_id/history", "params": [ { "name": "plan_definition_id", "value": "", "type": "path", "description": "The Billing Plan definition ID" } ] }, "docs": "Get Billing Plan definition history by definition id" }, { "info": { "name": "Set the state of a Billing Plan definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/billing_plans/:plan_definition_id/set_state", "params": [ { "name": "plan_definition_id", "value": "", "type": "path", "description": "The Billing Plan definition ID" } ] }, "docs": "Set the state of a Billing Plan definition" } ] }, { "info": { "name": "BillingPlanDefinitionVersions", "type": "folder" }, "items": [ { "info": { "name": "Fetch Billing Plan versions by ids", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/billing_plans/version/batch" }, "docs": "Fetch Billing Plan versions by ids" }, { "info": { "name": "Create a new version of a Billing Plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/billing_plans/version/create" }, "docs": "Create a new version of a Billing Plan" }, { "info": { "name": "Parse Billing Plan Version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/billing_plans/version/parse_import" }, "docs": "Parse and validate a raw json string to be used for importing a Billing Plan version" }, { "info": { "name": "Get Billing Plan version details by version_id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/billing_plans/version/:version_id", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "The Billing Plan version ID" } ] }, "docs": "Get Billing Plan version details by version_id" }, { "info": { "name": "Make a Billing Plan version the head version", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/billing_plans/version/:version_id/make_head", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "The Billing Plan version ID" } ] }, "docs": "Make a Billing Plan version the head version" }, { "info": { "name": "Make a Billing Plan version the release version", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/billing_plans/version/:version_id/make_release", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "The Billing Plan version ID" } ] }, "docs": "Make a Billing Plan version the release version" } ] }, { "info": { "name": "Copilot Governance", "type": "folder" }, "items": [ { "info": { "name": "Get Copilot Organization Metrics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/copilot_stats/org_metrics" }, "docs": "Retrieve Copilot organization-level metrics for a service account" }, { "info": { "name": "Get Copilot User Metrics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/copilot_stats/user_metrics" }, "docs": "Retrieve Copilot statistics at user level" } ] }, { "info": { "name": "CurrencyExchangeConfiguration", "type": "folder" }, "items": [ { "info": { "name": "Batch Currency Exchange Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/currency_exchange_configuration/batch" }, "docs": "Batch Currency Exchange Configuration." }, { "info": { "name": "Create Currency Exchange Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/currency_exchange_configuration/create" }, "docs": "Create Currency Exchange Configuration." }, { "info": { "name": "Get Currency Exchange Configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/currency_exchange_configuration/item/:item_id", "params": [ { "name": "item_id", "value": "", "type": "path" } ] }, "docs": "Get Currency Exchange Configuration." }, { "info": { "name": "Update Currency Exchange Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/currency_exchange_configuration/item/:item_id", "params": [ { "name": "item_id", "value": "", "type": "path" } ] }, "docs": "Update Currency Exchange Configuration." }, { "info": { "name": "Delete Currency Exchange Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/currency_exchange_configuration/item/:item_id", "params": [ { "name": "item_id", "value": "", "type": "path" } ] }, "docs": "Delete Currency Exchange Configuration." }, { "info": { "name": "List Currency Exchange Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/currency_exchange_configuration/list" }, "docs": "List Currency Exchange Configuration." } ] }, { "info": { "name": "Custom Tags", "type": "folder" }, "items": [ { "info": { "name": "List CustomTags by Master Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/custom_tags/master_account/:master_account_id", "params": [ { "name": "master_account_id", "value": "", "type": "path", "description": "specify the master account id" } ] }, "docs": "This GET method is used to retrieve the list of CustomTags available for a specific MasterAccount." }, { "info": { "name": "Set CustomTags by Master Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/custom_tags/master_account/:master_account_id", "params": [ { "name": "master_account_id", "value": "", "type": "path", "description": "specify the master account id" } ] }, "docs": "This Post method is used to update the list of CustomTags for a specific MasterAccount." }, { "info": { "name": "Delete CustomTags by Master Account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/custom_tags/master_account/:master_account_id", "params": [ { "name": "master_account_id", "value": "", "type": "path", "description": "specify the master account id" } ] }, "docs": "This delete method is used to delete the CustomTags for a specific MasterAccount" }, { "info": { "name": "List CustomTags by Tenant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/custom_tags/tenant/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "This GET method is used to retrieve the list of CustomTags available for a specific Tenant." }, { "info": { "name": "Set CustomTags by Tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/custom_tags/tenant/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "This Post method is used to update the list of CustomTags for a specific Tenant." }, { "info": { "name": "Delete CustomTags by Tenant", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/custom_tags/tenant/:tenant_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "This Delete method is used to delete the CustomTags for a specific Tenant." } ] }, { "info": { "name": "Dimension", "type": "folder" }, "items": [ { "info": { "name": "Batch Dimensions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dimensions/batch" }, "docs": "Retrieve the Dimension details for the specified ids" }, { "info": { "name": "Create a Dimension", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dimensions/create" }, "docs": "Create Dimension." }, { "info": { "name": "Get a Dimension", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/dimensions/item/:dimension_definition_id", "params": [ { "name": "dimension_definition_id", "value": "", "type": "path" } ] }, "docs": "Get Dimension." }, { "info": { "name": "Delete a Dimension", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/dimensions/item/:dimension_definition_id", "params": [ { "name": "dimension_definition_id", "value": "", "type": "path" } ] }, "docs": "Delete Dimension." }, { "info": { "name": "Get Dimension History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/dimensions/item/:dimension_definition_id/history", "params": [ { "name": "dimension_definition_id", "value": "", "type": "path" } ] }, "docs": "Get Dimension Definition History." }, { "info": { "name": "List Dimensions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dimensions/list" }, "docs": "Retrieve the ids of dimensions matching the filtering criteria" }, { "info": { "name": "Set Dimension State", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dimensions/:dimension_definition_id/set_state", "params": [ { "name": "dimension_definition_id", "value": "", "type": "path" } ] }, "docs": "Set Dimension State." } ] }, { "info": { "name": "DimensionVersion", "type": "folder" }, "items": [ { "info": { "name": "Batch Dimension Versions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dimensions/versions/batch" }, "docs": "Batch Dimension Definition Versions." }, { "info": { "name": "Create Dimension Version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dimensions/versions/create" }, "docs": "Create a New Dimension Definition Version." }, { "info": { "name": "Get Dimension Version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/dimensions/versions/item/:dimension_definition_version_id", "params": [ { "name": "dimension_definition_version_id", "value": "", "type": "path", "description": "ID of Dimension Definition Version." } ] }, "docs": "Get Dimension Definition Version." }, { "info": { "name": "Make Dimension Version Head", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/dimensions/versions/item/:dimension_definition_version_id/make-head", "params": [ { "name": "dimension_definition_version_id", "value": "", "type": "path", "description": "ID of Dimension Definition Version." } ] }, "docs": "Make Dimensions Definition Version Head." }, { "info": { "name": "Make Dimension Version Release", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/dimensions/versions/item/:dimension_definition_version_id/make-release", "params": [ { "name": "dimension_definition_version_id", "value": "", "type": "path", "description": "ID of Dimension Definition Version." } ] }, "docs": "Make Dimension Definition Version Release." } ] }, { "info": { "name": "Dashboard Definitions", "type": "folder" }, "items": [ { "info": { "name": "Get Active Dashboard Definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/executive_dashboard/active" }, "docs": "Get active Executive Dashboard" }, { "info": { "name": "Set Active Dashboard Definition", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/executive_dashboard/active", "params": [ { "name": "id", "value": "", "type": "query", "description": "ID of Dashboard Definition." } ] }, "docs": "Set Active Dashboard Definition" }, { "info": { "name": "Get all Dashboard Definitions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/executive_dashboard/all", "params": [ { "name": "onlyShared", "value": "", "type": "query", "description": "Filter to shared dashboards." } ] }, "docs": "Get all Dashboard Definitions" }, { "info": { "name": "Get Dashboard Definitions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/executive_dashboard/batch" }, "docs": "Batch Executive Dashboard definitions" }, { "info": { "name": "Create new Dashboard Definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/executive_dashboard/create" }, "docs": "Create Executive Dashboard definition" }, { "info": { "name": "Get Dashboard Definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/executive_dashboard/item/:dashboard_id", "params": [ { "name": "dashboard_id", "value": "", "type": "path", "description": "ID of Dashboard Definition." } ] }, "docs": "Get Dashboard Definition" }, { "info": { "name": "Delete Dashboard Definition", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/executive_dashboard/item/:dashboard_id", "params": [ { "name": "dashboard_id", "value": "", "type": "path", "description": "ID of Dashboard Definition." } ] }, "docs": "Delete Dashboard Definition" }, { "info": { "name": "Get Dashboard Definition ACL", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/executive_dashboard/item/:dashboard_id/acl", "params": [ { "name": "dashboard_id", "value": "", "type": "path", "description": "ID of Dashboard Definition." } ] }, "docs": "Get Dashboard Definition ACL" }, { "info": { "name": "Update Dashboard Definition ACL", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/executive_dashboard/item/:dashboard_id/acl", "params": [ { "name": "dashboard_id", "value": "", "type": "path", "description": "ID of Dashboard Definition." } ] }, "docs": "Update Dashboard Definition ACL" }, { "info": { "name": "Delete Dashboard Definition", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/executive_dashboard/item/:dashboard_id/acl", "params": [ { "name": "dashboard_id", "value": "", "type": "path", "description": "ID of Dashboard Definition." } ] }, "docs": "Delete Dashboard Definition" }, { "info": { "name": "Evaluate Dashboard Definition ACL context", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/executive_dashboard/item/:dashboard_id/acl_context", "params": [ { "name": "dashboard_id", "value": "", "type": "path", "description": "ID of Dashboard Definition." } ] }, "docs": "Evaluate Dashboard Definition ACL context" }, { "info": { "name": "Evaluate Dashboard Definition ACL", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/executive_dashboard/item/:dashboard_id/acl_eval", "params": [ { "name": "dashboard_id", "value": "", "type": "path", "description": "ID of Dashboard Definition." } ] }, "docs": "Evaluate Dashboard Definition ACL" }, { "info": { "name": "Get the history of a Dashboard Definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/executive_dashboard/item/:dashboard_id/history", "params": [ { "name": "dashboard_id", "value": "", "type": "path", "description": "ID of Dashboard Definition." } ] }, "docs": "Get the history of a Dashboard Definition" }, { "info": { "name": "List all accessible portals", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/executive_dashboard/portals/list" }, "docs": "List portals" }, { "info": { "name": "Resolve a portal path to its Dashboard Definition version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/executive_dashboard/portals/resolve", "params": [ { "name": "path", "value": "", "type": "query", "description": "Path of the Portal page." } ] }, "docs": "Resolve a portal path to its Dashboard Definition version" }, { "info": { "name": "Schedule the generation of a report for a dashboard", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/executive_dashboard/report/generate" }, "docs": "Create a report for a dashboard" }, { "info": { "name": "Fetch a report by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/executive_dashboard/report/item/:report_id", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "ID of the report to fetch. This can be retrieved using Report Generation API." } ] }, "docs": "Get a report for a dashboard" } ] }, { "info": { "name": "Dashboard Saved Views", "type": "folder" }, "items": [ { "info": { "name": "Create a saved view", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/executive_dashboard/saved_views" }, "docs": "Create a saved view (dashboard_id is optional and goes in the body)" }, { "info": { "name": "Get a saved view by identifier", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/executive_dashboard/saved_views/item/:view_id", "params": [ { "name": "view_id", "value": "", "type": "path", "description": "Unique identifier of the saved view." } ] }, "docs": "Resolve a saved view by its identifier" }, { "info": { "name": "Update a saved view", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/executive_dashboard/saved_views/item/:view_id", "params": [ { "name": "view_id", "value": "", "type": "path", "description": "Unique identifier of the saved view." } ] }, "docs": "Update an existing saved view" }, { "info": { "name": "Delete a saved view", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/executive_dashboard/saved_views/item/:view_id", "params": [ { "name": "view_id", "value": "", "type": "path", "description": "Unique identifier of the saved view." } ] }, "docs": "Soft-delete a saved view" }, { "info": { "name": "List saved views", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/executive_dashboard/saved_views/list" }, "docs": "List saved views with optional filters (POST with body so dashboard_id is optional)" } ] }, { "info": { "name": "Dashboard Definition Versions", "type": "folder" }, "items": [ { "info": { "name": "Get Dashboard Versions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/executive_dashboard_version/batch" }, "docs": "Batch Executive Dashboard versions" }, { "info": { "name": "Create new Dashboard Definition Version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/executive_dashboard_version/create" }, "docs": "Create Executive Dashboard version" }, { "info": { "name": "Get Dashboard Definition Version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/executive_dashboard_version/item/:version_id", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "ID of Dashboard Definition Version." } ] }, "docs": "Get Dashboard Definition Version" }, { "info": { "name": "Make Dashboard Definition Version the Head version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/executive_dashboard_version/item/:version_id/make-head", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "ID of Dashboard Definition Version." } ] }, "docs": "Make Dashboard Definition Version the Head version" }, { "info": { "name": "Make Dashboard Definition Version the Release version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/executive_dashboard_version/item/:version_id/make-release", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "ID of Dashboard Definition Version." } ] }, "docs": "Make Dashboard Definition Version the Release version" }, { "info": { "name": "Parse Dashboard Definition Version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/executive_dashboard_version/parseImport" }, "docs": "Validate Executive Dashboard version" } ] }, { "info": { "name": "Product", "type": "folder" }, "items": [ { "info": { "name": "List Feature requirements", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/feature_requirements/list" }, "docs": "List all Feature requirements within CoreStack product." }, { "info": { "name": "List Product Bundles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/product_bundles/list" }, "docs": "List all product bundles within CoreStack." }, { "info": { "name": "List Products", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/products/list" }, "docs": "List all product within CoreStack." }, { "info": { "name": "List Role Templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/role_templates/list" }, "docs": "List all Role templates within CoreStack." } ] }, { "info": { "name": "ServiceNow Integrations", "type": "folder" }, "items": [ { "info": { "name": "Create ServiceNow CMDB Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/integrations/servicenow/cmdb_config/create" }, "docs": "Create ServiceNowCMDBConfiguration" }, { "info": { "name": "Delete ServiceNow CMDB Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/integrations/servicenow/cmdb_config/delete" }, "docs": "Delete ServiceNowCMDBConfiguration" }, { "info": { "name": "List ServiceNow CMDB Configurations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/integrations/servicenow/cmdb_config/list" }, "docs": "List ServiceNow CMDB Configuration" }, { "info": { "name": "List ServiceNow CMDB CI Class Attributes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/integrations/servicenow/cmdb_config/list_cmdb_ci_class_attributes" }, "docs": "View CMDB CI Class Attributes" }, { "info": { "name": "List ServiceNow CMDB CI Classes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/integrations/servicenow/cmdb_config/list_cmdb_ci_classes" }, "docs": "View CMDB CI Class List" }, { "info": { "name": "List Inventory Attributes for Resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/integrations/servicenow/cmdb_config/list_inventory_attributes" }, "docs": "View Resource Inventory Schema" }, { "info": { "name": "Update ServiceNow CMDB Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/integrations/servicenow/cmdb_config/update" }, "docs": "Update ServiceNowCMDBConfiguration" }, { "info": { "name": "View ServiceNow CMDB Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/integrations/servicenow/cmdb_config/view" }, "docs": "View ServiceNowCMDBConfiguration" }, { "info": { "name": "View Cloud Schema Hierarchy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/integrations/servicenow/cmdb_config/view_hierarchy" }, "docs": "View Cloud Hierarchy" }, { "info": { "name": "Returns a batch of CMDB Sync Logs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/integrations/servicenow/cmdb_sync/logs/batch" }, "docs": "Get AWS Security hub findings for all ids passed in the request." }, { "info": { "name": "Returns a list CMDB Sync Log Ids", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/integrations/servicenow/cmdb_sync/logs/list" }, "docs": "List CMDB Sync Log Ids" }, { "info": { "name": "Cmdb Sync Progress", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/integrations/servicenow/cmdb_sync/progress/:cloud_account_id", "params": [ { "name": "cloud_account_id", "value": "", "type": "path" } ] }, "docs": "CMDB Sync Progress" }, { "info": { "name": "List ServiceNow User Groups", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/integrations/servicenow/list_assignment_groups" }, "docs": "List ServiceNow User Groups" }, { "info": { "name": "List ServiceNow Incident Custom Attributes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/integrations/servicenow/:service_account_id/incident/custom_reference_attributes", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account ID of ServiceNow." } ] }, "docs": "List Custom reference attributes of ServiceNow Incident" }, { "info": { "name": "List ServiceNow Request Attributes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/integrations/servicenow/:service_account_id/request/attributes", "params": [ { "name": "service_account_id", "value": "", "type": "path" } ] }, "docs": "View Service Request Attributes" }, { "info": { "name": "View ServiceNow Service Catalog Hierarchy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/integrations/servicenow/:service_account_id/request/service_catalog_hierarchy", "params": [ { "name": "service_account_id", "value": "", "type": "path" } ] }, "docs": "View Service Catalog Hierarchy" }, { "info": { "name": "List ServiceNow Table Rows", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/integrations/servicenow/:service_account_id/table/:table_name/rows", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account ID of ServiceNow." }, { "name": "table_name", "value": "", "type": "path", "description": "Specify the table name in ServiceNow to fetch rows" } ] }, "docs": "List ServiceNow Table Rows" } ] }, { "info": { "name": "Zoho Incident", "type": "folder" }, "items": [ { "info": { "name": "List Zoho ServiceDesk Sites", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/integrations/zoho/:service_account_id/incident/sites", "params": [ { "name": "service_account_id", "value": "", "type": "path" } ] }, "docs": "List Zoho ServiceDesk Sites" }, { "info": { "name": "List Zoho ServiceDesk Users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/integrations/zoho/:service_account_id/incident/users", "params": [ { "name": "service_account_id", "value": "", "type": "path" } ] }, "docs": "List Zoho ServiceDesk Users" } ] }, { "info": { "name": "Jira Service Management", "type": "folder" }, "items": [ { "info": { "name": "List Jira Service Management Project Fields", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/jira_service_management/project_fields/list" }, "docs": "Retrieve the list of Jira project fields for the service account" } ] }, { "info": { "name": "MasterAccount", "type": "folder" }, "items": [ { "info": { "name": "createMasterAccount", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/master_accounts" }, "docs": "Creates a new master account under a CoreStack account. There can be multiple tenants within a CoreStack account." }, { "info": { "name": "MasterAccountBatch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/master_accounts/batch" }, "docs": "Master Account Batch" }, { "info": { "name": "Master Account View", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/master_accounts/item/:master_account_id", "params": [ { "name": "master_account_id", "value": "", "type": "path" } ] }, "docs": "View the master account" }, { "info": { "name": "Master Account Update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/master_accounts/item/:master_account_id", "params": [ { "name": "master_account_id", "value": "", "type": "path" } ] }, "docs": "Update the master account" }, { "info": { "name": "Master Account Delete", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/master_accounts/item/:master_account_id", "params": [ { "name": "master_account_id", "value": "", "type": "path" } ] }, "docs": "Delete the master account" }, { "info": { "name": "ListMasterAccount", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/master_accounts/list" }, "docs": "List master account" } ] }, { "info": { "name": "UserGroups", "type": "folder" }, "items": [ { "info": { "name": "User Group List By Master Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/master_accounts/:master_account_id/user_groups", "params": [ { "name": "master_account_id", "value": "", "type": "path" } ] }, "docs": "User Group List By Master Account" }, { "info": { "name": "Create UserGroup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/user_groups" }, "docs": "Creates a user group within a CoreStack tenant and assign different set of roles to different users.There can be multiple user groups within a CoreStack tenant. User group will be created at the tenant level" }, { "info": { "name": "User Group Batch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/user_groups/batch" }, "docs": "User Group Batch" }, { "info": { "name": "Get UserGroup", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/user_groups/item/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path" } ] }, "docs": "Get User Group by ID" }, { "info": { "name": "Update UserGroup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/user_groups/item/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path" } ] }, "docs": "user group update within a CoreStack tenant and assign different set of roles to different users.There can be multiple user groups within a CoreStack tenant. User group will be updated at the tenant level" }, { "info": { "name": "Delete UserGroup", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/user_groups/item/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path" } ] }, "docs": "Delete User Group by ID" }, { "info": { "name": "User Group List", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/user_groups/list" }, "docs": "List User Groups" } ] }, { "info": { "name": "Master Data", "type": "folder" }, "items": [ { "info": { "name": "List Master data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/master_data/categories/list" }, "docs": "List Master Data Categories" } ] }, { "info": { "name": "Custom Metric Configuration", "type": "folder" }, "items": [ { "info": { "name": "Create Custom Metric Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/metric_configuration" }, "docs": "Create Custom Metric configuration Request" }, { "info": { "name": "Batch of Custom Metric Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/metric_configuration/batch" }, "docs": "List all custom metric configuration as batches" }, { "info": { "name": "Update Custom Metric Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/metric_configuration/item/:metric_configuration_id", "params": [ { "name": "metric_configuration_id", "value": "", "type": "path", "description": "Specify the Id of metric configuration to update, metric configuration id is unique can be obtained from the list custom metrics." } ] }, "docs": "Update Custom Metric Configuration is used to update the already created custom metrics for a cloud account." }, { "info": { "name": "Delete Custom Metric Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/metric_configuration/item/:metric_configuration_id", "params": [ { "name": "metric_configuration_id", "value": "", "type": "path", "description": "Specify the Id of metric configuration to delete, metric configuration id is unique can be obtained from the list custom metrics." } ] }, "docs": "Deletes a specific custom metric configuration for a cloud account." }, { "info": { "name": "List Custom Metric Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/metric_configuration/list" }, "docs": "List Custom Metric Configuration." }, { "info": { "name": "Manual Sync Custom Metric Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/metric_configuration/sync" }, "docs": "Sync custom metric Configuration for mentioned cloud accounts" } ] }, { "info": { "name": "On premises", "type": "folder" }, "items": [ { "info": { "name": "OnPremisesUtilizationMetricAggregateTrend", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/on_premises/utilization/metric" }, "docs": "Retrieve the Utilization metric Data for the given period of time in the granularity provided." } ] }, { "info": { "name": "Operations Utilization", "type": "folder" }, "items": [ { "info": { "name": "Batch Utilization Data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/operations/utilization_data/aggregate" }, "docs": "Retrieve the Utilization Data for the specified Resource ids" }, { "info": { "name": "List KPI statistics for Utilization Dashboard", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/operations/utilization_data/statistics" }, "docs": "Retrieve the Over all statistics for the vm utilization." } ] }, { "info": { "name": "Kubernetes Agent", "type": "folder" }, "items": [ { "info": { "name": "Complete the Multiple Parts upload for the Kubernetes agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/item/:service_account_id/complete_upload", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "Complete the Multiple Parts of a kubernetes agent upload to the bucket" }, { "info": { "name": "Get the attachment ID for the Kubernetes secrets configuration based on the given service account id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/resource/item/:service_account_id/generate_kubernetes_secrets_yaml", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "Generate a Kubernetes secrets manifest for the provided Kubernetes cluster account." }, { "info": { "name": "Get the Presigned url and other details for the Kubernetes agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/item/:service_account_id/generate_presigned_url", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "Generate Presigned_Url for Kubernetes agent to access the bucket" }, { "info": { "name": "Get the attachment ID for the Kubernetes deployment configuration based on the given service account id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/resource/item/:service_account_id/kubernetes_manifest", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "Generate a Kubernetes manifest for the provided Kubernetes cluster account." }, { "info": { "name": "Get the Job Sync Status of Kubernetes Cluster", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/resource/item/:service_account_id/sync", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "Get the Job Sync Status of Kubernetes Cluster" }, { "info": { "name": "Update the Sync Status of Kubernetes Cluster", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/resource/item/:service_account_id/sync", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "Update the Sync Status of Kubernetes Cluster" }, { "info": { "name": "Get the current configuration of the Kubernetes Agent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/resource/kubernetes/item/:service_account_id/configuration", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account ID to read, ID which can be obtained from the list service account API." } ] }, "docs": "Retrieve the current configuration of the Kubernetes Agent" } ] }, { "info": { "name": "AwsSsm Automation", "type": "folder" }, "items": [ { "info": { "name": "Execute automation document", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/automation/:document_id", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "document_id", "value": "", "type": "path" } ] }, "docs": "Execute a automation document with all required parameters" }, { "info": { "name": "Cancel Automation Execution", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/automation/:execution_id", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "execution_id", "value": "", "type": "path" } ] }, "docs": "Cancel a specific automation document execution" }, { "info": { "name": "Batch execution steps", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/execution/step/batch", "params": [ { "name": "tenant_id", "value": "", "type": "path" } ] }, "docs": "List all document execution steps batch" }, { "info": { "name": "List execution steps", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/execution/step/list/:execution_id", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "execution_id", "value": "", "type": "path" } ] }, "docs": "List all document execution Steps" } ] }, { "info": { "name": "AwsSsm Command", "type": "folder" }, "items": [ { "info": { "name": "Execute command document", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/command/:document_id", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "document_id", "value": "", "type": "path" } ] }, "docs": "Execute a command document with all required parameters" }, { "info": { "name": "Cancel command execution", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/command/:execution_id", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "execution_id", "value": "", "type": "path" } ] }, "docs": "Cancel a specific command document execution" }, { "info": { "name": "Batch execution instances", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/execution/instance/batch", "params": [ { "name": "tenant_id", "value": "", "type": "path" } ] }, "docs": "List all document execution Instance batch" }, { "info": { "name": "List execution instances", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/execution/instance/list/:execution_id", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "execution_id", "value": "", "type": "path" } ] }, "docs": "List all document execution Instances" } ] }, { "info": { "name": "AwsSsm", "type": "folder" }, "items": [ { "info": { "name": "Batch Document versions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/document/:document_id/versions/batch", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "document_id", "value": "", "type": "path" } ] }, "docs": "List document version batches" }, { "info": { "name": "List Document versions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/document/:document_id/versions/history", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "document_id", "value": "", "type": "path" } ] }, "docs": "List all document versions" }, { "info": { "name": "List document filters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/document/:document_type/filters", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "document_type", "value": "", "type": "path" } ] }, "docs": "List Document Filters" }, { "info": { "name": "Batch SSM Documents", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/documents/batch", "params": [ { "name": "tenant_id", "value": "", "type": "path" } ] }, "docs": "List all SSM document batches" }, { "info": { "name": "Batch executions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/documents/execution/batch", "params": [ { "name": "tenant_id", "value": "", "type": "path" } ] }, "docs": "List all document execution batches" }, { "info": { "name": "List executions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/documents/execution/list", "params": [ { "name": "tenant_id", "value": "", "type": "path" } ] }, "docs": "List all document executions" }, { "info": { "name": "List Documents", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/documents/list", "params": [ { "name": "tenant_id", "value": "", "type": "path" } ] }, "docs": "List all SSM Documents" }, { "info": { "name": "Manual document sync", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/documents/sync", "params": [ { "name": "tenant_id", "value": "", "type": "path" } ] }, "docs": "Sync SSM Documents for mentioned cloud accounts" }, { "info": { "name": "List execution filters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/execution/filters/:document_type", "params": [ { "name": "tenant_id", "value": "", "type": "path" }, { "name": "document_type", "value": "", "type": "path" } ] }, "docs": "List Execution Filters" }, { "info": { "name": "Batch execution job groups", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/execution/group/batch", "params": [ { "name": "tenant_id", "value": "", "type": "path" } ] }, "docs": "List all document execution group batches" }, { "info": { "name": "List execution job groups", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/runbook/:tenant_id/AWS/execution/group/list", "params": [ { "name": "tenant_id", "value": "", "type": "path" } ] }, "docs": "List all document execution groups" } ] }, { "info": { "name": "Schedules", "type": "folder" }, "items": [ { "info": { "name": "Fetch a batch of schedules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/schedules/batch" }, "docs": "Fetch a batch of schedules" }, { "info": { "name": "Creates a Schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/schedules/create" }, "docs": "Creates a Schedule" }, { "info": { "name": "Retrieve Schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/schedules/item/:schedule_id", "params": [ { "name": "schedule_id", "value": "", "type": "path", "description": "Specify the schedule Id to retrieve the schedule data" } ] }, "docs": "Retrieve details of given schedule" }, { "info": { "name": "Updates a Schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/schedules/item/:schedule_id", "params": [ { "name": "schedule_id", "value": "", "type": "path", "description": "Specify the schedule Id to update the schedule data" } ] }, "docs": "Update schedule" }, { "info": { "name": "Delete Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/schedules/item/:schedule_id", "params": [ { "name": "schedule_id", "value": "", "type": "path", "description": "Specify the schedule Id to remove the schedule data" } ] }, "docs": "Delete given schedule" }, { "info": { "name": "Set Next Execution of a Schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/schedules/item/:schedule_id/set_next_execution", "params": [ { "name": "schedule_id", "value": "", "type": "path", "description": "Specify the schedule Id to remove the schedule data" } ] }, "docs": "Set Next Execution of a Schedule" }, { "info": { "name": "Skip next execution of a Schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/schedules/item/:schedule_id/skip_next_execution", "params": [ { "name": "schedule_id", "value": "", "type": "path", "description": "Specify the schedule Id to remove the schedule data" } ] }, "docs": "Skip next execution of a Schedule" }, { "info": { "name": "List Schedules of given category", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/schedules/list" }, "docs": "List schedules of given Category" } ] }, { "info": { "name": "Service Account Resources", "type": "folder" }, "items": [ { "info": { "name": "Threat Validation for GCP Services", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/security/threat/:service_account_id/gcp/validate", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "Security Threat Validation for GCP" }, { "info": { "name": "Threat Validation for OCI services", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/security/threat/:service_account_id/oci/validate", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "Security Threat Validation for OCI" }, { "info": { "name": "Vulnerability Validation for GCP Services", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/security/vulnerability/:service_account_id/gcp/validate", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "Security Vulnerability Validation for GCP" }, { "info": { "name": "Vulnerability Validation for OCI services", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/security/vulnerability/:service_account_id/oci/validate", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "Security Vulnerability Validation for OCI" }, { "info": { "name": "List Available AWS S3 Buckets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/aws/buckets", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "List the available AWS S3 buckets for the cloud account" }, { "info": { "name": "List Available AWS CloudTrail By Region", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/aws/trails/:region", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" }, { "name": "region", "value": "", "type": "path", "description": "Specify the region to fetch trails" } ] }, "docs": "List the AWS CloudTrail of a region on cloud account" }, { "info": { "name": "List Available Azure Action Groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/azure/action_groups", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "List the available Azure action groups for the cloud account" }, { "info": { "name": "List Available Azure Activity Log Alerts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/azure/activity_log_alerts", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "List the available Azure activity log alerts for the cloud account" }, { "info": { "name": "List Available Azure Log Analytics Workspaces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/azure/log_analytics_workspaces", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "List the available Azure log analytics workspaces for the cloud account" }, { "info": { "name": "List Available Azure Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/azure/subscriptions", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "List the available Azure subscriptions for the cloud account" }, { "info": { "name": "List billing metrics for a cloud account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/billing_metrics", "params": [ { "name": "service_account_id", "value": "", "type": "path" } ] }, "docs": "List the billing metrics for an account" }, { "info": { "name": "List Available GCS Buckets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/gcp/buckets", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "List the available GCS buckets for the cloud account" }, { "info": { "name": "List the repositories in a gitHub account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/github/repositories", "params": [ { "name": "service_account_id", "value": "", "type": "path" } ] }, "docs": "List the repositories for a github account" } ] }, { "info": { "name": "StacksMarketplaceProduct", "type": "folder" }, "items": [ { "info": { "name": "Batch Stacks Marketplace Products", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/products/batch" }, "docs": "Batch Stacks Marketplace Products." }, { "info": { "name": "Create Stacks Marketplace Product", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/products/create" }, "docs": "Create a new Stacks Marketplace Product." }, { "info": { "name": "Get Stacks Marketplace Product", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/stacks-marketplace/products/item/:product_id", "params": [ { "name": "product_id", "value": "", "type": "path" } ] }, "docs": "Get Stacks Marketplace Product." }, { "info": { "name": "Update Stacks Marketplace Product", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/products/item/:product_id", "params": [ { "name": "product_id", "value": "", "type": "path" } ] }, "docs": "Update Stacks Marketplace Product." }, { "info": { "name": "Delete Stacks Marketplace Product", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/stacks-marketplace/products/item/:product_id", "params": [ { "name": "product_id", "value": "", "type": "path" } ] }, "docs": "Delete Stacks Marketplace Product." }, { "info": { "name": "List Stacks Marketplace Products", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/products/list" }, "docs": "List Stacks Marketplace Products." } ] }, { "info": { "name": "StacksMarketplaceStackDefinitionVersion", "type": "folder" }, "items": [ { "info": { "name": "Batch Stacks Marketplace Stack Definition Versions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definition-versions/batch" }, "docs": "Batch Stacks Marketplace Stack Definition Versions." }, { "info": { "name": "Create Stacks Marketplace Stack Definition Version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definition-versions/create" }, "docs": "Create a new Stacks Marketplace Stack Definition Version." }, { "info": { "name": "Get Stacks Marketplace Stack Definition Version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definition-versions/item/:stack_definition_version_id", "params": [ { "name": "stack_definition_version_id", "value": "", "type": "path", "description": "ID of Stack Definition Version." } ] }, "docs": "Get Stacks Marketplace Stack Definition Version." }, { "info": { "name": "Initiates the cost estimation of a deployment run that could happen on a service account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definition-versions/item/:stack_definition_version_id/cost-estimate", "params": [ { "name": "stack_definition_version_id", "value": "", "type": "path", "description": "ID of Stack Definition Version." } ] }, "docs": "Initiate cost estimation of a deployment run that could happen on a service account" }, { "info": { "name": "Gets the cost estimation of a deployment run that could happen on a service account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definition-versions/item/:stack_definition_version_id/cost-estimate/:background_job_id/status", "params": [ { "name": "stack_definition_version_id", "value": "", "type": "path", "description": "ID of Stack Definition Version." }, { "name": "background_job_id", "value": "", "type": "path", "description": "ID of background job which performs the cost estimation of the given Stack Definition Version." } ] }, "docs": "Gets Estimated cost of a deployment run that could happen on a service account" }, { "info": { "name": "Make Stacks Marketplace Stack Definition Version Head", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definition-versions/item/:stack_definition_version_id/make-head", "params": [ { "name": "stack_definition_version_id", "value": "", "type": "path", "description": "ID of Stack Definition Version." } ] }, "docs": "Make Stacks Marketplace Stack Definition Version Head." }, { "info": { "name": "Make Stacks Marketplace Stack Definition Version Release", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definition-versions/item/:stack_definition_version_id/make-release", "params": [ { "name": "stack_definition_version_id", "value": "", "type": "path", "description": "ID of Stack Definition Version." } ] }, "docs": "Make Stacks Marketplace Stack Definition Version Release." }, { "info": { "name": "Get Stacks Marketplace Stack Definitions Version Publishing History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definition-versions/item/:stack_definition_version_id/publishing/:master_account_id/history", "params": [ { "name": "stack_definition_version_id", "value": "", "type": "path", "description": "ID of Stack Definition Version." }, { "name": "master_account_id", "value": "", "type": "path", "description": "ID of the Source Master Account." } ] }, "docs": "Get Stacks Marketplace Stack Definitions Version publishing log for a Master Account." }, { "info": { "name": "Get State for Stacks Marketplace Stack Definition Version Publishing", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definition-versions/item/:stack_definition_version_id/publishing/:master_account_id/state", "params": [ { "name": "stack_definition_version_id", "value": "", "type": "path", "description": "ID of Stack Definition Version." }, { "name": "master_account_id", "value": "", "type": "path", "description": "ID of the Source Master Account." } ] }, "docs": "GetState for the stack definition version publishing state." }, { "info": { "name": "Set State for Stacks Marketplace Stack Definition Version Publishing", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definition-versions/item/:stack_definition_version_id/publishing/:master_account_id/state", "params": [ { "name": "stack_definition_version_id", "value": "", "type": "path", "description": "ID of Stack Definition Version." }, { "name": "master_account_id", "value": "", "type": "path", "description": "ID of the Source Master Account." } ] }, "docs": "SetState for the stack definition version publishing state." }, { "info": { "name": "Set Stacks Marketplace Stack Definition Version State", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definition-versions/item/:stack_definition_version_id/set-state", "params": [ { "name": "stack_definition_version_id", "value": "", "type": "path", "description": "ID of Stack Definition Version." } ] }, "docs": "Set Stacks Marketplace Stack Definition Version State." } ] }, { "info": { "name": "StacksMarketplaceStackDefinition", "type": "folder" }, "items": [ { "info": { "name": "Batch Stacks Marketplace Stack Definitions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definitions/batch" }, "docs": "Batch Stacks Marketplace Stack Definitions." }, { "info": { "name": "Create Stacks Marketplace Stack Definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definitions/create" }, "docs": "Create a new Stacks Marketplace Stack Definition." }, { "info": { "name": "Get Stacks Marketplace Stack Definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definitions/item/:stack_definition_id", "params": [ { "name": "stack_definition_id", "value": "", "type": "path", "description": "ID of Stack Definition." } ] }, "docs": "Get Stacks Marketplace Stack Definition." }, { "info": { "name": "Get Stacks Marketplace Stack Definition History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definitions/item/:stack_definition_id/history", "params": [ { "name": "stack_definition_id", "value": "", "type": "path", "description": "ID of Stack Definition." } ] }, "docs": "Get Stacks Marketplace Stack Definition History." }, { "info": { "name": "Set Stacks Marketplace Stack Definition State", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definitions/item/:stack_definition_id/set-state", "params": [ { "name": "stack_definition_id", "value": "", "type": "path", "description": "ID of Stack Definition." } ] }, "docs": "Set Stacks Marketplace Stack Definition State." }, { "info": { "name": "List Stacks Marketplace Stack Definitions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-definitions/list" }, "docs": "List Stacks Marketplace Stack Definitions." } ] }, { "info": { "name": "StacksMarketplaceStackDeployment", "type": "folder" }, "items": [ { "info": { "name": "Batch Stacks Marketplace Stack Deployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-deployment/batch" }, "docs": "Batch Stacks Marketplace Stack Deployments." }, { "info": { "name": "Create Stacks Marketplace Stack Deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-deployment/create" }, "docs": "Create a new Stacks Marketplace Stack Deployment" }, { "info": { "name": "Batch Stacks Marketplace Stack Deployment History", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-deployment/history/batch" }, "docs": "Batch Stacks Marketplace Stack Deployment History." }, { "info": { "name": "Get Stacks Marketplace Stack Deployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-deployment/item/:stack_deployment_id", "params": [ { "name": "stack_deployment_id", "value": "", "type": "path", "description": "ID of Stack Deployment." } ] }, "docs": "Get Stacks Marketplace Stack Deployment." }, { "info": { "name": "Execute Stacks Marketplace Stack Deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-deployment/item/:stack_deployment_id/execute", "params": [ { "name": "stack_deployment_id", "value": "", "type": "path", "description": "ID of Stack Deployment." } ] }, "docs": "Execute Stacks Marketplace Stack Deployment." }, { "info": { "name": "Get Stacks Marketplace Stack Deployment History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-deployment/item/:stack_deployment_id/history", "params": [ { "name": "stack_deployment_id", "value": "", "type": "path", "description": "ID of Stack Deployment." } ] }, "docs": "Get Stacks Marketplace Stack Deployment History IDs." }, { "info": { "name": "List Stacks Marketplace Stack Deployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stacks-marketplace/stack-deployment/list" }, "docs": "List Stacks Marketplace Stack Deployments." } ] }, { "info": { "name": "SummaryDashboard", "type": "folder" }, "items": [ { "info": { "name": "Get cloud-wise cost usage and top resource consumption data for the service accounts in a tenant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/summary_dashboard/cloud_wise_usage" }, "docs": "Get cloud-wise cost usage and top resource consumption data for the service accounts in a tenant" } ] }, { "info": { "name": "Freshservice Tickets", "type": "folder" }, "items": [ { "info": { "name": "List Departments accessible by the user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/support/freshservice/departments/list" }, "docs": "Retrieve the departments accessible by the user." }, { "info": { "name": "Creates a new FreshService Ticket", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/support/freshservice/tickets/create" }, "docs": "Creates a ticket in FreshService" }, { "info": { "name": "Freshservice Ticket Filters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/support/freshservice/tickets/filters" }, "docs": "Freshservice Ticket Filters" }, { "info": { "name": "Get FreshService Ticket details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/support/freshservice/tickets/item/:ticket_id", "params": [ { "name": "ticket_id", "value": "", "type": "path", "description": "Specify the ticket ID. This is a unique ID and can be retrieved using the List Ticket API." } ] }, "docs": "Retrieve the current details of ticket" }, { "info": { "name": "List FreshService Tickets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/support/freshservice/tickets/list" }, "docs": "List FreshService Tickets" } ] }, { "info": { "name": "TaggingGovernanceDefinitions", "type": "folder" }, "items": [ { "info": { "name": "Get all Tag Baseline Definitions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tag_baseline/all" }, "docs": "Get a list of all Tag Baseline Definitions that are viewable to the user." }, { "info": { "name": "Get Baselines", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_baseline/batch" }, "docs": "Batch Tag Baseline definitions" }, { "info": { "name": "Create new Tag Baseline", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_baseline/create" }, "docs": "Create a new Tag Baseline Definition. The definition is used to manage a set of versions. This request takes no body" }, { "info": { "name": "Get Tag Baseline Definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tag_baseline/item/:baseline_id", "params": [ { "name": "baseline_id", "value": "", "type": "path", "description": "ID of Tag Baseline Definition." } ] }, "docs": "Get a Tag Baseline Definition by id." }, { "info": { "name": "Delete Tag Baseline Definition", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/tag_baseline/item/:baseline_id", "params": [ { "name": "id", "value": "", "type": "query", "description": "ID of Tag Baseline Definition." }, { "name": "baseline_id", "value": "", "type": "path" } ] }, "docs": "Delete a Tag Baseline Definition and all associated versions. Returns 'true' if the operation was successful." }, { "info": { "name": "Get the history of a Tag Baseline Definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tag_baseline/item/:baseline_id/history", "params": [ { "name": "baseline_id", "value": "", "type": "path", "description": "ID of Tag Baseline Definition." } ] }, "docs": "Get a list of all versions for a Tag Baseline Definition." }, { "info": { "name": "Set state of Tag Baseline Definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_baseline/item/:baseline_id/set-state", "params": [ { "name": "baseline_id", "value": "", "type": "path", "description": "ID of Tag Baseline Definition Version." } ] }, "docs": "Set the Active state for a Tag Baseline Definition. When the state is true, the baseline will be used in posture generation." }, { "info": { "name": "Returns a batch of AvailableTag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_baselines/available_tags/batch" }, "docs": "Get all tag values for the tag keys passed in the request." }, { "info": { "name": "Returns a list of AvailableTags ids", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_baselines/available_tags/list" }, "docs": "Get a list of all available tag keys found on resources that the user can view." }, { "info": { "name": "Get enhanced tags from the user's tags", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_baselines/enhance_tags" }, "docs": "Get enhanced tags from the user's tags." }, { "info": { "name": "Returns Generated Tags", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_baselines/generate_tags" }, "docs": "Get AI-recommended tags from the user's prompt." } ] }, { "info": { "name": "TaggingGovernanceDefinitionVersions", "type": "folder" }, "items": [ { "info": { "name": "Get Dashboard Versions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_baseline_version/batch" }, "docs": "Batch Tag Baseline versions" }, { "info": { "name": "Create new Tag Baseline Definition Version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_baseline_version/create" }, "docs": "Create a Tag Baseline Definition Version. This will create and link a new version to the given definition id." }, { "info": { "name": "Get Tag Baseline Definition Version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tag_baseline_version/item/:version_id", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "ID of Tag Baseline Definition Version." } ] }, "docs": "Get a Tag Baseline Definition Version by id." }, { "info": { "name": "Make Tag Baseline Definition Version the Head version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tag_baseline_version/item/:version_id/make-head", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "ID of Tag Baseline Definition Version." } ] }, "docs": "Mark this version as the 'head' version." }, { "info": { "name": "Make Tag Baseline Definition Version the Release version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tag_baseline_version/item/:version_id/make-release", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "ID of Tag Baseline Definition Version." } ] }, "docs": "Mark this version as the release version. The release version will be used for posture generation" }, { "info": { "name": "Parse Tag Baseline Definition Version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_baseline_version/parseImport" }, "docs": "Parse and validate a raw json string to be used for importing a Tag Baseline Definition Version" } ] }, { "info": { "name": "TaggingGovernancePostures", "type": "folder" }, "items": [ { "info": { "name": "Returns a batch of TagPostureSnapshot", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_posture/snapshot/batch" }, "docs": "Get details for the snapshot ids passed in the request" }, { "info": { "name": "Returns a TagPostureSnapshot", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_posture/snapshot/create" }, "docs": "Create a new snapshot. This will generate the tag posture with the currently active baselines. Old snapshots will be cleaned up based on the 'keep' parameter" }, { "info": { "name": "Returns a batch of TagPostureResources", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_posture/snapshot/item/:snapshot_id/resource/batch", "params": [ { "name": "snapshot_id", "value": "", "type": "path", "description": "ID of snapshot" } ] }, "docs": "For a given snapshot, get the details of the requested resources" }, { "info": { "name": "Returns a TagPostureResource based on input filters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tag_posture/snapshot/item/:snapshot_id/resource/item/:resource_id", "params": [ { "name": "snapshot_id", "value": "", "type": "path", "description": "Snapshot to use for evaluating baselines (\"live\" computes the posture on demand)" }, { "name": "resource_id", "value": "", "type": "path", "description": "ID of resource to fetch" }, { "name": "baseline_id", "value": "", "type": "query", "description": "Baseline to evaluate resource against (all if missing)" } ] }, "docs": "Get posture details for a particular resource." }, { "info": { "name": "Summarize the tag posture matching the filtering criteria returning resource coverage counts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_posture/snapshot/item/:snapshot_id/resource_summary", "params": [ { "name": "snapshot_id", "value": "", "type": "path", "description": "ID of snapshot" } ] }, "docs": "For a given snapshot, list all of the posture summaries for resources. Allows filtering and sorting based on the request" }, { "info": { "name": "Returns a batch of TagPostureCloudAccountSummary", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_posture/snapshot/item/:snapshot_id/summary/cloud_account/batch", "params": [ { "name": "snapshot_id", "value": "", "type": "path", "description": "ID of snapshot" }, { "name": "baseline_id", "value": "", "type": "query", "description": "Baseline to fetch summary for (all if missing)" } ] }, "docs": "For a given snapshot, get the details of the requested cloud account posture summaries" }, { "info": { "name": "Returns a list of TagPostureCloudAccountSummary identifiers based on input filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_posture/snapshot/item/:snapshot_id/summary/cloud_account/list", "params": [ { "name": "snapshot_id", "value": "", "type": "path", "description": "ID of snapshot" } ] }, "docs": "For a given snapshot, list all of the posture summaries for cloud accounts. Allows filtering and sorting based on the request" }, { "info": { "name": "Returns a batch of TagPostureResourceSummary", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_posture/snapshot/item/:snapshot_id/summary/resource/batch", "params": [ { "name": "snapshot_id", "value": "", "type": "path", "description": "ID of snapshot" }, { "name": "baseline_id", "value": "", "type": "query", "description": "Baseline to fetch summary for (all if missing)" } ] }, "docs": "For a given snapshot, get the details of the requested resource posture summaries" }, { "info": { "name": "Returns a list of TagPostureResourceSummary identifiers based on input filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_posture/snapshot/item/:snapshot_id/summary/resource/list", "params": [ { "name": "snapshot_id", "value": "", "type": "path", "description": "ID of snapshot" } ] }, "docs": "For a given snapshot, list all of the posture summaries for resources. Allows filtering and sorting based on the request" }, { "info": { "name": "Get a TagPostureSummary for Workload", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tag_posture/snapshot/item/:snapshot_id/workload_summary/:workload_id", "params": [ { "name": "snapshot_id", "value": "", "type": "path", "description": "ID of Snapshot" }, { "name": "workload_id", "value": "", "type": "path", "description": "ID of Workload" } ] }, "docs": "For a given snapshot, get the details of the requested workload cloud posture summaries" }, { "info": { "name": "Returns a batch of TagPostureWorkloadResourceSummary", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_posture/snapshot/item/:snapshot_id/workload_summary/:workload_id/resource/list", "params": [ { "name": "snapshot_id", "value": "", "type": "path", "description": "ID of snapshot" }, { "name": "workload_id", "value": "", "type": "path", "description": "ID of Workload" } ] }, "docs": "For a given snapshot, get the details of the requested workload resource posture summaries" }, { "info": { "name": "Returns a list of TagPostureSnapshot ids", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tag_posture/snapshot/list" }, "docs": "Get the list of all Tag Posture Snapshot. Each snapshot represents the tag posture generated at a particular time with a set of baselines." } ] }, { "info": { "name": "UserPreference", "type": "folder" }, "items": [ { "info": { "name": "List all subkeys of user preferences", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/user_preferences/:user_id/subkey/list", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "Specify the user ID. This is a unique ID and can be retrieved using the List Users API." } ] }, "docs": "Get a list of all the subkeys for user preferences that are viewable to the user under the certain path." }, { "info": { "name": "User Preference Delete", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/user_preferences/:user_id/value/delete", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "Specify the user ID. This is a unique ID and can be retrieved using the List Users API." } ] }, "docs": "Delete a user preference" }, { "info": { "name": "Get details of the user preference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/user_preferences/:user_id/value/get", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "Specify the user ID. This is a unique ID and can be retrieved using the List Users API." } ] }, "docs": "Get user preference by id." }, { "info": { "name": "List all user preferences", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/user_preferences/:user_id/value/list", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "Specify the user ID. This is a unique ID and can be retrieved using the List Users API." } ] }, "docs": "Get a list of all the user preferences that are viewable to the user under the certain path." }, { "info": { "name": "Create a new user preference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/user_preferences/:user_id/value/set", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "Specify the user ID. This is a unique ID and can be retrieved using the List Users API." } ] }, "docs": "Create/Update a user preference" }, { "info": { "name": "Update updated_at time for user preference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/user_preferences/:user_id/value/used", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "Specify the user ID. This is a unique ID and can be retrieved using the List Users API." } ] }, "docs": "Update user preference updated_at time" } ] }, { "info": { "name": "WellArchitectedFramework", "type": "folder" }, "items": [ { "info": { "name": "Framework Best Practice Delete", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/waf-frameworks/:tenant_id/best_practice/delete", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Delete a Well-Architected Framework Best practice" }, { "info": { "name": "Sync Framework from AWS or To AWS", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/waf-frameworks/:tenant_id/framework/:framework_id/sync", "params": [ { "name": "framework_id", "value": "", "type": "path" }, { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Sync Well-Architected Framework from CS or from AWS" }, { "info": { "name": "Framework Pillar Delete", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/waf-frameworks/:tenant_id/pillar/delete", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Delete a Well-Architected Framework Pillar" }, { "info": { "name": "Framework Question Delete", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/waf-frameworks/:tenant_id/question/delete", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Delete a Well-Architected Framework Question" }, { "info": { "name": "Batch Best Practices", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/:tenant_id/best-practice/batch", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Get a batch of best practices for tenant specified" }, { "info": { "name": "Best practices Create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/:tenant_id/best-practice/create", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Add Best Practices to a Well-Architected Framework Question" }, { "info": { "name": "Best practice Update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/:tenant_id/best-practice/update", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Update Best Practice for a Well-Architected Framework Question" }, { "info": { "name": "Batch Frameworks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/:tenant_id/framework/batch", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Get a batch of Frameworks" }, { "info": { "name": "Framework Create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/:tenant_id/framework/create", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Create a Well-Architected Framework" }, { "info": { "name": "List Frameworks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/well-architected-framework/:tenant_id/framework/list", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "List all Frameworks for the specified tenant" }, { "info": { "name": "Framework Update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/:tenant_id/framework/update", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Update a Well-Architected Framework" }, { "info": { "name": "Framework Delete", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/well-architected-framework/:tenant_id/framework/:framework_id/delete", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." }, { "name": "framework_id", "value": "", "type": "path", "description": "ID of Custom Framework. This can be retrieved using the List Frameworks API" } ] }, "docs": "Delete a Well-Architected Framework" }, { "info": { "name": "Add pillars to a framework", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/:tenant_id/pillar/create", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Add pillars to a Well-Architected Framework" }, { "info": { "name": "Pillar update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/:tenant_id/pillar/update", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Update a pillar of a Well-Architected Framework" }, { "info": { "name": "Batch Questions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/:tenant_id/question/batch", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Get a batch of questions for tenant specified" }, { "info": { "name": "Create Questions for a pillar of a framework", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/:tenant_id/question/create", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Add Questions to a Well-Architected Framework" }, { "info": { "name": "Question Update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/:tenant_id/question/update", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Update a Question in a Well-Architected Framework" } ] }, { "info": { "name": "WafAssessmentDefinitions", "type": "folder" }, "items": [ { "info": { "name": "Get Dashboard Versions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-definition/batch" }, "docs": "Fetch a batch of Assessment Definitions" }, { "info": { "name": "Create new Assessment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-definition/create" }, "docs": "Create a new Assessment Definition. The definition is used to manage a set of versions. This request takes no body" }, { "info": { "name": "Get Assessment Definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-definition/item/:assessment_id", "params": [ { "name": "assessment_id", "value": "", "type": "path", "description": "ID of Assessment Definition. This can be retrieved using Filter Assessment Definitions API." } ] }, "docs": "Get a Assessment Definition by id." }, { "info": { "name": "Delete Assessment Definition", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-definition/item/:assessment_id", "params": [ { "name": "assessment_id", "value": "", "type": "path", "description": "ID of Assessment Definition. This can be retrieved using Filter Assessment Definitions API." } ] }, "docs": "Delete a Assessment Definition and all associated versions. Returns 'true' if the operation was successful." }, { "info": { "name": "Get the history of an Assessment Definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-definition/item/:assessment_id/history", "params": [ { "name": "assessment_id", "value": "", "type": "path", "description": "ID of Assessment Definition. This can be retrieved using Filter Assessment Definitions API." } ] }, "docs": "Get a list of all versions for a Assessment Definition." }, { "info": { "name": "Set state of Assessment Definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-definition/item/:assessment_id/set-state", "params": [ { "name": "assessment_id", "value": "", "type": "path", "description": "ID of Assessment Definition. This can be retrieved using Filter Assessment Definitions API." } ] }, "docs": "Set the Active state for a Assessment Definition. When the state is true, the Assessment will be used in resource selection." }, { "info": { "name": "Filter Assessment Definitions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-definition/list" }, "docs": "Get a list of all Assessment Definitions that are viewable to the user." } ] }, { "info": { "name": "WafAssessmentRuns", "type": "folder" }, "items": [ { "info": { "name": "Get a batch of Assessment Run History details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-run-history/batch" }, "docs": "Get a batch of Assessment Run History details." }, { "info": { "name": "Get a list of RecordIdentity for resources that have violated the given policy job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-run-history/item/:assessment_run_history_id/violations", "params": [ { "name": "assessment_run_history_id", "value": "", "type": "path", "description": "ID of the Assessment Run History. This can be retrieved using get history IDs Filter API." } ] }, "docs": "Get a list of resources that have violated the given policy job" }, { "info": { "name": "Get the history IDs for the given filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-run-history/list" }, "docs": "Get the history IDs for the given filters." }, { "info": { "name": "Get a batch of Assessment Run History Question details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-run-question/batch", "params": [ { "name": "assessment_run_history_id", "value": "", "type": "query", "description": "ID of the Assessment Run History" } ] }, "docs": "Get a batch of Assessment Run History Question details." }, { "info": { "name": "Get the Question IDs for the given filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-run-question/list" }, "docs": "Get the Question IDs for the given filters." }, { "info": { "name": "Get a batch of assessment run details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-run/batch" }, "docs": "Get a batch of assessment run" }, { "info": { "name": "Start an assessment run for the assessment definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-run/create" }, "docs": "Create an assessment run for a given Assessment Definition" }, { "info": { "name": "Fetch the details for an assessment run by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-run/item/:assessment_run_id", "params": [ { "name": "assessment_run_id", "value": "", "type": "path", "description": "ID of Assessment Run. This can retrieved using List Assessment run Filter API" } ] }, "docs": "Get an assessment run by ID" }, { "info": { "name": "Answer a question or best practice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-run/item/:assessment_run_id/answer", "params": [ { "name": "assessment_run_id", "value": "", "type": "path", "description": "ID of Assessment Run. This can retrieved using List Assessment run Filter API" } ] }, "docs": "Answer a question or best practice\nAllows adding attachments, comments, and setting state for best practice or question" }, { "info": { "name": "Create a milestone - take snapshot of the current state of assessment run including state of questions, best practices, comments and attachments associated alongside", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-run/item/:assessment_run_id/milestone", "params": [ { "name": "assessment_run_id", "value": "", "type": "path", "description": "ID of Assessment Run. This can retrieved using List Assessment run Filter API" } ] }, "docs": "Create a milestone on the Assessment Run." }, { "info": { "name": "Start a scan for an assessment run using the given context", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-run/item/:assessment_run_id/scan", "params": [ { "name": "assessment_run_id", "value": "", "type": "path", "description": "ID of Assessment Run. This can retrieved using List Assessment run Filter API" } ] }, "docs": "Start a scan for an assessment run using the given context" }, { "info": { "name": "Set the state for an assessment run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-run/item/:assessment_run_id/set-state", "params": [ { "name": "assessment_run_id", "value": "", "type": "path", "description": "ID of Assessment Run. This can retrieved using List Assessment run Filter API" } ] }, "docs": "Set the state for an assessment run. Used to complete or abandon the run\nUsed to complete or abandon the run" }, { "info": { "name": "Get all assessment run IDs for the given filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-run/list" }, "docs": "Get all assessment run identities for the given filters" }, { "info": { "name": "List of assessment run report details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment/report/batch" }, "docs": "List of assessment run report details" }, { "info": { "name": "Schedule the generation of a report for an assessment run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment/report/generate" }, "docs": "Create a report for an assessment" }, { "info": { "name": "Fetch an assessment run report by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/well-architected-framework/assessment/report/item/:report_id", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "ID of the report to fetch. This can be retrieved using Report Generation API." } ] }, "docs": "Get a report for an assessment" }, { "info": { "name": "Get a list of assessment run report ids for given filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment/report/list" }, "docs": "Get a list of assessment run report ids for given filters" } ] }, { "info": { "name": "WafAssessmentDefinitionVersions", "type": "folder" }, "items": [ { "info": { "name": "Get Assessment Versions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-version/batch" }, "docs": "Fetch a batch of Assessment Versions" }, { "info": { "name": "Create new Assessment Definition Version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-version/create" }, "docs": "Create a Assessment Definition Version. This will create and link a new version to the given definition id." }, { "info": { "name": "Get Assessment Definition Version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-version/item/:version_id", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "ID of Assessment Definition Version." } ] }, "docs": "Get a Assessment Definition Version by id." }, { "info": { "name": "Make Assessment Definition Version the Head version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-version/item/:version_id/make-head", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "ID of Assessment Definition Version." } ] }, "docs": "Mark this version as the 'head' version." }, { "info": { "name": "Make Assessment Definition Version the Release version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-version/item/:version_id/make-release", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "ID of Assessment Definition Version." } ] }, "docs": "Mark this version as the release version. The release version will be used for posture generation" }, { "info": { "name": "Set state of Assessment Definition Version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-version/item/:version_id/set-state", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "ID of Assessment Definition Version." }, { "name": "state", "value": "", "type": "query", "description": "Version state to transition to" } ] }, "docs": "Set the version state for a Assessment Definition Version. This is used to approve or reject a draft version" }, { "info": { "name": "Parse Assessment Definition Version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/well-architected-framework/assessment-version/parseImport" }, "docs": "Parse and validate a raw json string to be used for importing a Assessment Definition Version" } ] }, { "info": { "name": "WorkloadDefinitions", "type": "folder" }, "items": [ { "info": { "name": "Get Dashboard Versions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workload-definition/batch" }, "docs": "Fetch a batch of Workload Definitions" }, { "info": { "name": "Create new Workload", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workload-definition/create" }, "docs": "Create a new Workload Definition. The definition is used to manage a set of versions. This request takes no body" }, { "info": { "name": "Get Workload Definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workload-definition/item/:workload_id", "params": [ { "name": "workload_id", "value": "", "type": "path", "description": "ID of Workload Definition. This can be retrieved using Filter Definition API." } ] }, "docs": "Get a Workload Definition by id." }, { "info": { "name": "Delete Workload Definition", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workload-definition/item/:workload_id", "params": [ { "name": "workload_id", "value": "", "type": "path", "description": "ID of Workload Definition. This can be retrieved using Filter Definition API." } ] }, "docs": "Delete a Workload Definition and all associated versions. Returns 'true' if the operation was successful." }, { "info": { "name": "Get the history of a Workload Definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workload-definition/item/:workload_id/history", "params": [ { "name": "workload_id", "value": "", "type": "path", "description": "ID of Workload Definition. This can be retrieved using Filter Definition API." } ] }, "docs": "Get a list of all versions for a Workload Definition." }, { "info": { "name": "Set state of Workload Definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workload-definition/item/:workload_id/set-state", "params": [ { "name": "workload_id", "value": "", "type": "path", "description": "ID of Workload Definition. This can be retrieved using Filter Definition API." } ] }, "docs": "Set the Active state for a Workload Definition. When the state is true, the Workload will be used in resource selection." }, { "info": { "name": "Filter Workload Definitions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workload-definition/list" }, "docs": "Get a list of all Workload Definitions that are viewable to the user." }, { "info": { "name": "Set state in Bulk for Workload Definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workload-definition/set-state-bulk" }, "docs": "Set State of a list of workload definitions in bulk" } ] }, { "info": { "name": "WorkloadQuery", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of Resource identifiers based on input query", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workload-query/execute" }, "docs": "Execute a query against the ServiceResourceInventory collection given a WorkloadTierConfiguration" }, { "info": { "name": "Returns a list of ServiceResourceInventory", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workload-query/resource/batch" }, "docs": "Fetch a batch of resources from the ServiceResourceInventory collection" }, { "info": { "name": "Returns list of WorkloadServiceResourceRegion with all possible filter values for the given cloud accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workload-query/resource/filters/region" }, "docs": "Fetch all the region filter values for the given cloud accounts" }, { "info": { "name": "Returns list of WorkloadServiceResource with all possible filter values for the given cloud accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workload-query/resource/filters/service-resource" }, "docs": "Fetch all the ServiceResource filter values" } ] }, { "info": { "name": "WorkloadDefinitionVersions", "type": "folder" }, "items": [ { "info": { "name": "Get Workload Versions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workload-version/batch" }, "docs": "Fetch a batch of Workload Versions" }, { "info": { "name": "Create new Workload Definition Version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workload-version/create" }, "docs": "Create a Workload Definition Version. This will create and link a new version to the given definition id." }, { "info": { "name": "Get Workload Definition Version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workload-version/item/:version_id", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "ID of Workload Definition Version." } ] }, "docs": "Get a Workload Definition Version by id." }, { "info": { "name": "Make Workload Definition Version the Head version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workload-version/item/:version_id/make-head", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "ID of Workload Definition Version." } ] }, "docs": "Mark this version as the 'head' version." }, { "info": { "name": "Make Workload Definition Version the Release version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workload-version/item/:version_id/make-release", "params": [ { "name": "version_id", "value": "", "type": "path", "description": "ID of Workload Definition Version." } ] }, "docs": "Mark this version as the release version. The release version will be used for posture generation" }, { "info": { "name": "Parse Workload Definition Version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workload-version/parseImport" }, "docs": "Parse and validate a raw json string to be used for importing a Workload Definition Version" } ] }, { "info": { "name": "AuditLog", "type": "folder" }, "items": [ { "info": { "name": "Audit Detail", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/audit/auditlog/batch" }, "docs": "List all Audit Log document batches" }, { "info": { "name": "Audit List", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/audit/auditlog/list" }, "docs": "Audit Log List" } ] }, { "info": { "name": "Billing", "type": "folder" }, "items": [ { "info": { "name": "Aggregate costs based on input criteria", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing/aggregation" }, "docs": "Generate cost aggregation." }, { "info": { "name": "Aggregate costs based on input criteria", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing/aggregation/batch" }, "docs": "Generate cost aggregations in a batch." }, { "info": { "name": "Aggregate costs in a trend based on input criteria", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing/aggregation/trend" }, "docs": "Generate cost aggregation trend." }, { "info": { "name": "Retrieves the aggregated trend of usage, rate and cost over a specified time period", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing/cost_and_usage/aggregation/trend" }, "docs": "Generate cost and usage aggregation trend." }, { "info": { "name": "Get description trend results", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing/description/aggregation/trend" }, "docs": "Generate description trend." }, { "info": { "name": "List extra keys used in service accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing/extras" }, "docs": "List extra keys for service accounts." }, { "info": { "name": "Return distinct billing line-item identities including tags, without time-series data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing/identities" }, "docs": "Return distinct line-item identities (with tags) matching the request, without timestamps or cost values." }, { "info": { "name": "List values for group_by key used in service accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing/line_items_summary" }, "docs": "List values for group_by keys." }, { "info": { "name": "List tag keys used in service accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing/platform/tags" }, "docs": "List tag keys values and kind for platform service accounts." }, { "info": { "name": "Aggregate rate in a trend based on input criteria", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing/rate/aggregation/trend" }, "docs": "Generate Rate aggregation trend." }, { "info": { "name": "List tag keys used in service accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing/tags" }, "docs": "List tag keys for service accounts." }, { "info": { "name": "Aggregate usage in a trend based on input criteria", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing/usage/aggregation/trend" }, "docs": "Generate usage aggregation trend." }, { "info": { "name": "Fetch Billing Information", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing_info/batch" }, "docs": "Fetch Billing Info." } ] }, { "info": { "name": "Billing Metric", "type": "folder" }, "items": [ { "info": { "name": "Batch of Billing Metric Access", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing_metrics/access/batch" }, "docs": "Get a Batch of Billing Metric Access" }, { "info": { "name": "Create new Billing Metric Access", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing_metrics/access/create" }, "docs": "Create Billing Metric Access." }, { "info": { "name": "Update Billing Metric Access", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing_metrics/access/item/:access_id", "params": [ { "name": "access_id", "value": "", "type": "path", "description": "The Id of Billing Metric access to update." } ] }, "docs": "Update Billing Metrics." }, { "info": { "name": "Delete Billing Metric Access", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/billing_metrics/access/item/:access_id", "params": [ { "name": "access_id", "value": "", "type": "path" } ] }, "docs": "Deletes a billing metric." }, { "info": { "name": "List Billing Metric Access", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing_metrics/access/list" }, "docs": "List Billing Metric Access." }, { "info": { "name": "Batch of Billing Metrics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing_metrics/batch" }, "docs": "Get a Batch of Billing Metrics" }, { "info": { "name": "Create new Billing Metrics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing_metrics/create" }, "docs": "Create Billing Metrics." }, { "info": { "name": "Update Billing Metrics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing_metrics/item/:billing_metrics_id", "params": [ { "name": "billing_metrics_id", "value": "", "type": "path", "description": "The Id of Billing Metrics to update." } ] }, "docs": "Update Billing Metrics." }, { "info": { "name": "Delete Billing Metrics", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/billing_metrics/item/:billing_metrics_id", "params": [ { "name": "billing_metrics_id", "value": "", "type": "path" } ] }, "docs": "Deletes a billing metric." }, { "info": { "name": "List Billing Metrics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/billing_metrics/list" }, "docs": "List Billing Metrics." } ] }, { "info": { "name": "Operations Utilization Metric Dashboard", "type": "folder" }, "items": [ { "info": { "name": "Utilization metric aggregate trend endpoint", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/operations/resource_utilization_metrics/aggregate_trend" }, "docs": "Retrieve the Utilization metric Data for the given period of time in the granularity provided." } ] }, { "info": { "name": "PlatformTask", "type": "folder" }, "items": [ { "info": { "name": "Assign Platform Task to Service Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/platform/task/assign" }, "docs": "Assign platform related background tasks to service accounts" }, { "info": { "name": "Send Logs from Platform Agent for Service Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/platform/:service_account_id/logs", "params": [ { "name": "service_account_id", "value": "", "type": "path" } ] }, "docs": "Send the logs from the platform agent for a service account" }, { "info": { "name": "Check Assigned Platform Task for Service Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/platform/:service_account_id/task", "params": [ { "name": "service_account_id", "value": "", "type": "path" } ] }, "docs": "Check assigned platform related background tasks for a service account" }, { "info": { "name": "Update Assigned Platform Task for Service Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/platform/:service_account_id/task", "params": [ { "name": "service_account_id", "value": "", "type": "path" } ] }, "docs": "Update assigned platform related background tasks for a service account" } ] }, { "info": { "name": "Recommendation V2 Dashboard", "type": "folder" }, "items": [ { "info": { "name": "Batch Recommendations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/recommendation_dashboard/recommendations/batch" }, "docs": "Retrieve the Recommendation savings details for the resource" }, { "info": { "name": "List Recommendations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/recommendation_dashboard/recommendations/list" }, "docs": "Retrieve the ids of Recommendations which are matching the criteria" }, { "info": { "name": "manage the recommendations for the workflow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/recommendation_dashboard/recommendations/manage" }, "docs": "Request the action for the workflow" }, { "info": { "name": "Statistics for Recommendations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/recommendation_dashboard/recommendations/statistics" }, "docs": "Retrieve the Recommendation savings statistics for the filters applied" } ] }, { "info": { "name": "NextGen Reports", "type": "folder" }, "items": [ { "info": { "name": "Create a NextGen report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/reports/generate" }, "docs": "Create a report" }, { "info": { "name": "Fetch a report by ID", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/reports/item/:report_id", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "ID of the report to fetch. This can be retrieved using Report Generation API." } ] }, "docs": "Get a report by ID" } ] }, { "info": { "name": "Savings Plans", "type": "folder" }, "items": [ { "info": { "name": "List savings plan purchase recommendations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/savings_plans/recommendations" }, "docs": "List savings plan purchase recommendations across one or more tenants in a single call." }, { "info": { "name": "List purchased savings plan details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/savings_plans/:tenant_id/purchased/details", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "List purchased savings plan details for one or more service accounts, excluding utilization time-series." }, { "info": { "name": "Get savings plan utilization metrics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/savings_plans/:tenant_id/purchased/utilization", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API." } ] }, "docs": "Fetch paginated utilization time-series for a single purchased savings plan. plan_id is required." } ] }, { "info": { "name": "Schedule Recommendations", "type": "folder" }, "items": [ { "info": { "name": "Schedule Recommendations Filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/schedule_recommendations/filters" }, "docs": "Schedule Recommendations Filters" }, { "info": { "name": "Schedule Recommendations Resource Schedule List", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/schedule_recommendations/list_resource_schedule" }, "docs": "Schedule Recommendations Resource Schedule List" }, { "info": { "name": "Schedule Recommendations Schedule List", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/schedule_recommendations/list_schedules" }, "docs": "Schedule Recommendations Schedule List" }, { "info": { "name": "Schedule Recommendations Overview", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/schedule_recommendations/overview" }, "docs": "Schedule Recommendations Overview" }, { "info": { "name": "Postpone Schedule Recommendation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/schedule_recommendations/postpone" }, "docs": "Postpone Schedule Recommendations" }, { "info": { "name": "Reactivate Schedule Recommendation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/schedule_recommendations/reactivate" }, "docs": "Reactivate Schedule Recommendations" }, { "info": { "name": "Reject Schedule Recommendation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/schedule_recommendations/reject" }, "docs": "Reject Schedule Recommendations" }, { "info": { "name": "Remediate Schedule Recommendation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/schedule_recommendations/remediate" }, "docs": "Remediate Schedule Recommendations" }, { "info": { "name": "Schedule Recommendations Resource Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/schedule_recommendations/resource_details" }, "docs": "Schedule Recommendations Resource Details" }, { "info": { "name": "Schedule Recommendations Summary", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/schedule_recommendations/summary" }, "docs": "Schedule Recommendations Summary" }, { "info": { "name": "Trigger Cost Savings Calculation Schedule Recommendation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/schedule_recommendations/trigger_cost_savings_calculation" }, "docs": "Trigger Cost Savings Calculations for Schedule Recommendations" }, { "info": { "name": "Schedule Recommendations Utilization Definitions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/schedule_recommendations/utilization_definitions" }, "docs": "Schedule Recommendations Utilization Definitions" }, { "info": { "name": "Schedule Recommendations Utilization Metrics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/schedule_recommendations/utilization_metrics" }, "docs": "Schedule Recommendations Utilization Metrics" } ] }, { "info": { "name": "Service Account Governance", "type": "folder" }, "items": [ { "info": { "name": "Batch Service Account Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/service_account/batch" }, "docs": "Retrieve the Service Account details for the specified ids" }, { "info": { "name": "Create a new Service Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/service_account/create" }, "docs": "Creates a new Service Account" }, { "info": { "name": "Get Service Account details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account ID to read, ID which can be obtained from the list service account API." } ] }, "docs": "Retrieve the current details of the service account" }, { "info": { "name": "Update Service Account details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account ID to update, ID which can be obtained from the list service account API." } ] }, "docs": "Update the details of the service account" }, { "info": { "name": "Delete Service Account details", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account ID to delete, ID which can be obtained from the list service account API." } ] }, "docs": "Delete the service account" }, { "info": { "name": "Fetch Service Account Cloud Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/cloud_tags", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "Fetch the cloud tags for the service account" }, { "info": { "name": "List of Available OCI Compartments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/compartments", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "List the available compartments for the cloud account" }, { "info": { "name": "Validate Service Account Credentials", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/credentials_validation", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account id to read, cloud account id is unique can be obtained from the list cloud account api.This should be same as the ID of the reference API" } ] }, "docs": "Performs validation of credentials associated with the service account" }, { "info": { "name": "Validate update of Service Account details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/dry_run", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account ID to validate, ID which can be obtained from the list service account API." } ] }, "docs": "Validate if the details can be applied to the service account" }, { "info": { "name": "Validate update of Service Account details and check if the Governance Configuration can be accepted by the Cloud/Tool provider", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/extended_dry_run", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account ID to validate, ID which can be obtained from the list service account API." } ] }, "docs": "Validate if the details can be applied to the service account and the Governance Configuration is acceptable by the Cloud/Tool provider" }, { "info": { "name": "List Available Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/locations", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "List the available location for the cloud account" }, { "info": { "name": "List Available Azure Resource Groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/resource_groups", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the account id" } ] }, "docs": "List the available resource groups for the cloud account" }, { "info": { "name": "Get Current Sync Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/sync_status", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account id to read, cloud account id is unique can be obtained from the list cloud account api.This should be same as the ID of the reference API" } ] }, "docs": "Retrieve the current sync status of the service account" }, { "info": { "name": "Trigger refresh of Sync Status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/sync_status", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account id to read, cloud account id is unique can be obtained from the list cloud account api.This should be same as the ID of the reference API" } ] }, "docs": "Trigger the refresh of the sync status of the service account" }, { "info": { "name": "Get Sync Status History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/service_account/item/:service_account_id/sync_status_history", "params": [ { "name": "service_account_id", "value": "", "type": "path", "description": "Specify the service account id to read, cloud account id is unique can be obtained from the list cloud account api.This should be same as the ID of the reference API" } ] }, "docs": "Retrieve the historical sync status of the service account" }, { "info": { "name": "List Service Accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/service_account/list" }, "docs": "Retrieve the ids of service accounts matching the filtering criteria" }, { "info": { "name": "Summarize Service Accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/service_account/summary" }, "docs": "Summarize the service accounts matching the filtering criteria returning counts for each group" } ] }, { "info": { "name": "Pricing", "type": "folder" }, "items": [ { "info": { "name": "Get cloud SKU unit pricing from MongoDB", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/sku_unit_price" }, "docs": "Retrieve cloud SKU unit pricing from MongoDB. Provide service, sku_name, and region to look up pricing. Use attributes for service-specific filters: os (EC2), db_engine / deployment (RDS), cache_engine (ElastiCache). EC2 match_confidence is \"approximate\" — OS is matched but AMI-level variants are not disambiguated. For RESERVED pricing, omit payment_option to return all three upfront variants (NO/PARTIAL/ALL_UPFRONT) in the rates array." } ] }, { "info": { "name": "Pro Active Scanner Configurations", "type": "folder" }, "items": [ { "info": { "name": "List the governance scanner rules for a GitHub account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/:service_account_id/scanner_configuration/list_master_rules", "params": [ { "name": "service_account_id", "value": "", "type": "path" } ] }, "docs": "List the master rules for a scanner configuration" } ] } ], "bundled": true }