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

External APIs 4.3 (2401) - What's Changed Part-II

What's Changed

  • GET/governance/guardrails/{tenant_id}/recommendations/{recommendation_id} Describe Policy Recommendations

📘

Return Type

  • Deleteactions.name//recommendation action name
  • Deleteactions.terms_and_conditions//Terms and conditions for performing the recommended action
  • Deleteactions.resource_level//if the action will be performed at the resource level
  • Deleteactions.action_type//Type of action will be always template
  • Deleteactions.action_resource_name//Name of template
  • Deleteactions.description//Description about the action in details
  • POST/operation/automation/scripts/{tenant_id} Create Script

📘

Parameter

  • Add CreateScriptRequest.script_info.content//File content, if path type is specified as file
  • Add CreateScriptRequest.dependencies.content//File content, if path type is specified as file
  • Change CreateScriptRequest.scope
  • Change CreateScriptRequest.script_info.path_type
  • Change CreateScriptRequest.dependencies.path_type
  • POST/operation/automation/scripts/{tenant_id}/scan Scan Script

📘

Parameter

  • Add ScriptScanRequest.script_info.content//File content, if path type is specified as file
  • Add ScriptScanRequest.dependencies.content//File content, if path type is specified as file
  • Change ScriptScanRequest.script_info.path_type
  • Change ScriptScanRequest.dependencies.path_type
  • GET/operation/automation/template/{tenant_id}/get/{job_id} View Template Job

📘

Return Type

  • Add id//Unique ID of the Template Job
  • Add name//Name of the Template Job
  • Add created_at//Template Job start time in UTC
  • Add terraform_state//Terraform Template state
  • Add args//Template Job execution template inputs arguments
  • Add output//Template Job outputs
  • Add attachment_id//Terraform job log ID
  • Add resources
  • Deletetemplate_job_id//Unique ID of the Template Job
  • Deletetemplate_job_name//Name of the Template Job
  • Deletestarted_at//Template Job start time in UTC
  • Change status
  • Change status_reason
  • Change completed_at
  • Change execution_type
  • GET/operation/automation/template/{tenant_id}/jobs/list List Templates Jobs

📘

Return Type

  • Add jobs.id//Unique ID of the template job.
  • Deletejobs.template_job_id//Unique ID of the template job.
  • Change jobs.name
  • Change jobs.status
  • Change jobs.type
  • Change jobs.status_reason
  • Change jobs.username
  • Change jobs.job_actions
  • POST/operation/automation/templates/{tenant_id} Create Template

📘

Parameter

  • Add CreateTemplateRequest
  • DeleteCreateTemplateReq
  • DELETE/operation/automation/{tenant_id}/scripts/{script_id} Delete Script

📘

Return Type

  • Deletemessage//Delete Response message.
  • PUT/operation/automation/{tenant_id}/scripts/{script_id} Update Script

📘

Parameter

  • Add CreateScriptRequest.script_info.content//File content, if path type is specified as file
  • Add CreateScriptRequest.dependencies.content//File content, if path type is specified as file
  • Change CreateScriptRequest.scope
  • Change CreateScriptRequest.script_info.path_type
  • Change CreateScriptRequest.dependencies.path_type
  • GET/operation/automation/{tenant_id}/scripts/{script_id} Describe Script

📘

Return Type

  • Change category
  • DELETE/operation/automation/{tenant_id}/templates/{template_id} Delete Template

📘

Return Type

  • Deletemessage//Delete Template Response message.
  • PUT/operation/automation/{tenant_id}/templates/{template_id} Update Template

📘

Parameter

  • Add CreateTemplateRequest
  • DeleteCreateTemplateReq

📘

Return Type

  • Deletemessage//Response Message on template update
  • GET/operation/automation/{tenant_id}/templates/{template_id} Describe Template

📘

Return Type

  • Change updated_at
  • POST/operation/automation/{tenant_id}/templates/{template_id}/execute Execute Template

📘

Parameter

  • Add TemplateExecuteRequest
  • DeleteTemplateExecuteReqModel
  • POST/operation/automation/{tenant_id}/templates/{template_id}/get_params Get Template Params

📘

Parameter

  • Add TemplateGetParamsRequest
  • DeleteTemplateGetParamsReqModel
  • POST/operation/automation/{tenant_id}/templates/{template_id}/validate Validate Template

📘

Parameter

  • Add TemplateValidateRequest
  • DeleteTemplateValidateReqModel
  • POST/operation/posture/dashboard_summary List Operation Posture Details For Mobile Site

📘

Parameter

  • Change OperationPostureRequest.service_name (Added Enum)
  • GET/operation/{tenant_id}/visibility/{cloud}/list List Operation Visibility Details

📘

Return Type

  • Deleteresource_list_data.environment//environment
  • POST/operations/activity/{tenant_id}/create Create New Activity Configuration

📘

Parameter

  • Add CreateActivityRequest
  • DeleteCreateActivityRequestModel
  • GET/operations/activity/{tenant_id}/get_configuration_summary Get Activity Configuration Summary

📘

Parameter

  • Change service
  • GET/operations/activity/{tenant_id}/list_activity_operations List Operations Activity Details by Resource & Resource Type

📘

Parameter

  • Change service
  • PUT/operations/activity/{tenant_id}/update/{cloud_account_id}/{action_name} Update Activity Configuration

📘

Parameter

  • Add UpdateActivityRequest
  • DeleteUpdateActivityRequestModel

📘

Return Type

  • Deletemessage//Update Activity Response
  • PUT/operations/activity/{tenant_id}/{cloud_account_id}/update/{activity_id}/{action_name} Update Activity Configuration Details

📘

Return Type

  • Deletemessage//Update Activity Response
  • POST/operations/automation/blueprints/{tenant_id}/create Create Blueprints

📘

Return Type

  • Deletestatus//Status of the create call for the blueprint
  • Deletemessage//Message of the create call for the blueprint
  • Change blueprint_id
  • DELETE/operations/automation/blueprints/{tenant_id}/delete/{blueprint_id} Delete Blueprints

📘

Return Type

  • Deletestatus//Status of the delete call for the blueprint
  • Deletemessage//Message of the delete call for the blueprint
  • PUT/operations/automation/blueprints/{tenant_id}/update/{blueprint_id} Update Blueprints

📘

Return Type

  • Deletestatus//Status of the update call for the blueprint
  • Deletemessage//Message of the update call for the blueprint
  • POST/operations/automation/scripts/{tenant_id}/create Create Script Schedules

📘

Return Type

  • Deletestatus//Status of the Create Schedule Call
  • Deletemessage//Message of the Create Schedule Call
  • Change schedule_id
  • PUT/operations/automation/scripts/{tenant_id}/update/{schedule_id} Update Script Schedules

📘

Return Type

  • Deletestatus//Status of the Update Schedule Call
  • Deletemessage//Message of the Update Schedule Call
  • POST/operations/automation/templates/{tenant_id}/create Create Template Schedules

📘

Return Type

  • Deletestatus//Status of the Create Schedule Call
  • Deletemessage//Message of the Create Schedule Call
  • Change schedule_id
  • PUT/operations/automation/templates/{tenant_id}/update/{schedule_id} Update Template Schedules

📘

Return Type

  • Deletestatus//Status of the Update Schedule Call
  • Deletemessage//Message of the Update Schedule Call
  • DELETE/operations/automation/{tenant_id}/delete/{schedule_id} Delete Template and Script Schedules

📘

Return Type

  • Deletestatus//Status of the Delete Schedule Call
  • Deletemessage//Message of the Delete Schedule Call
  • POST/operations/monitoring_and_alerts/cloud_accounts/{tenant_id}/apply_template Apply Operations Alert Configuration

📘

Parameter

  • Add ApplyTemplateRequest.regions//Select the regions to which the template to be applied, when the AWS cloud account is selected
  • Add ApplyTemplateRequest.resource_groups//Select the resource_groups to which the template to be applied, when the Azure cloud account is selected

📘

Return Type

  • Deletemessage
  • GET/operations/monitoring_and_alerts/cloud_accounts/{tenant_id}/list_cloud_account_configurations List Operations Alert Configuration by Cloud Account

📘

Return Type

  • Deletemessage
  • GET/operations/monitoring_and_alerts/cloud_accounts/{tenant_id}/list_cloud_account_details Get Service Details For Operations Alert Configuration

📘

Return Type

  • Add data//get service details response
  • Change message
  • POST/operations/monitoring_and_alerts/cloud_accounts/{tenant_id}/view_applied View Applied Operations Alert Configuration

📘

Return Type

  • Deletemessage//Applied resource details retrieved successfully
  • POST/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/clone_template Clone Operations Alert Configuration Templates

📘

Parameter

  • Add CloneTemplateRequest.regions//Select regions when scope is selected as region for an AWS cloud
  • Add CloneTemplateRequest.resource_groups//Select resource_groups when scope is selected as resource_group for an Azure cloud
  • Add CloneTemplateRequest.apply_to_existing_resource//Select the check box, if wish to apply the configuration for existing resources also
  • DeleteCloneTemplateRequest.constraints.option//Option Value of Tag Details
  • DeleteCloneTemplateRequest.constraints.type//Type of Template Details
  • DeleteCloneTemplateRequest.constraints.tags//Tag keys and Tag values of Template Details. eg) {"XZV":["ZNCDF", "dfsgsg"]}
  • Change CloneTemplateRequest.is_default
  • POST/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/create_template Create Operations Alert Configuration Templates

📘

Parameter

  • Add CreateAlertTemplateRequest
  • DeleteCreateTemplateRequest
  • PUT/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/edit_template Update Operations Alert Configuration Template

📘

Return Type

  • Deletemessage//Edit template configuration response
  • PUT/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/edit_template_name Update Operations Alert Configuration Template Name

📘

Return Type

  • Deletemessage//Edit template name response
  • PUT/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/enable_default_template Set Default Options Operations Alert Configuration

📘

Return Type

  • Deletemessage//set template as default response
  • GET/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/list_alert_templates List Operations Alert Configuration Templates

📘

Return Type

  • Deletemessage
  • POST/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/resource_metric_hierarchy_configuration List Operations Resource Metric Hierarchy Configuration

📘

Parameter

  • Change ResourceMetricHierarchyRequest.service (Added Enum)
  • POST/recommendations/{definition_id}/resolve Resolve Definition Recommendation

📘

Parameter

  • Add ResolveDefRecommendationsRequest
  • DeleteResolveDefRecommendationsReqModel

📘

Return Type

  • Deletestatus//Status of pre-execute
  • Deletemessage//pre-execute
  • POST/recommendations/{definition_id}/resolve_preexecute Resolve Recommendation Action Preexecute

📘

Parameter

  • Add ExecuteResolveActionRecommendationsRequest
  • DeleteExecuteResolveActionRecommendationsReqModel
  • POST/recommendations/{tenant_id}/resolve/{recommendation_id} Resolve Recommendation

📘

Parameter

  • Add ResolveRecommendationsRequest
  • DeleteResolveRecommendationsRequestModel

📘

Return Type

  • Deletestatus//Status of that HTTP call
  • Deletemessage//Message of HTTP call
  • POST/recommendations/{tenant_id}/resolve_preexecute/{recommendation_id} Resolve PreExecute Recommendation

📘

Parameter

  • Add ExecuteResolveRecommendationsRequest
  • DeleteExecuteResolveRecommendationsReqModel
  • GET/resource/inventory/{tenant_id}/cloud_account Getting the resources cloud account details based on the tenant

📘

Parameter

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

📘

Parameter

  • Change CategoryCountRequest.filters.service (Added Enum)
  • POST/resource/inventory/{tenant_id}/filters List Inventory Filters

📘

Parameter

  • Add InventoryFilterRequest
  • Change service_name
  • DeleteInventoryFilterRequestModel
  • POST/resource/inventory/{tenant_id}/resource_listing Get Resource Listing

📘

Parameter

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

📘

Parameter

  • Change InventoryResourceDetailsRequest.filters.service (Added Enum)
  • GET/resource/posture/account_or_tenant/visibility List Resource Visibility Count

📘

Parameter

  • Change cloud
  • GET/resource/posture/account_or_tenant/visibility/resources_without_locks_or_tags List Resource Visibility Details

📘

Parameter

  • Change cloud
  • GET/resource/posture/list List Resource Posture Details

📘

Parameter

  • Change service_name
  • POST/resource/tags/{tenant_id}/remediation Create Resource Tag Remediation

📘

Parameter

  • Change CreateRemediationRequest.cloud (Added Enum)
  • POST/resource/tags/{tenant_id}/remediation_status/{cloud} Get Resource Tag Remediation Status

📘

Parameter

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

📘

Parameter

  • Change SecurityDashboardRequest.filter.clouds

📘

Return Type

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

📘

Parameter

  • Change SecurityDashboardRequest.filter.clouds

📘

Return Type

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

📘

Parameter

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

📘

Parameter

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

📘

Parameter

  • Change SecurityDashboardRequest.filter.clouds

📘

Return Type

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

📘

Parameter

  • Change SecurityDashboardRequest.filter.clouds

📘

Return Type

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

📘

Parameter

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

📘

Parameter

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

📘

Parameter

  • Change SecurityDashboardRequest.filter.clouds

📘

Return Type

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

📘

Parameter

  • Change SecurityDashboardRequest.filter.clouds

📘

Return Type

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

📘

Parameter

  • Change SecurityDashboardRequest.filter.clouds
  • GET/security/posture/visibility/{tenant_id}/get/vulnerability List Security Vulnerability Details

📘

Parameter

  • Change services

📘

Return Type

  • Deletestatus//status response
  • Deletemessage//message response
  • GET/security/posture/visibility/{tenant_id}/get/{action_name} List Security Visibility Details

📘

Parameter

  • Change services

📘

Return Type

  • Change count_summary
  • GET/security/posture/{tenant_id}/get/securityops/{action_name} Get Security Posture Details by Cloud Account & Cloud Service Provider

📘

Parameter

  • Change service_name
  • DELETE/self_service/resource_catalogs/{tenant_id}/{catalog_id} Delete Resource Catalog

📘

Return Type

  • Deletemessage//Resource deleted
  • PUT/self_service/resource_catalogs/{tenant_id}/{catalog_id} Update Resource Catalog

📘

Return Type

  • Deletemessage//Resource Modified
  • DELETE/self_service/{tenant_id}/catalog/{cloud_account_id} Delete Service Catalog

📘

Return Type

  • Deletemessage//Cloud Account Default values cleared successfully
  • GET/tenants List Tenant

📘

Return Type

  • Add tenants.is_default//Is the master tenant
  • DELETE/tenants/{tenant_id} Delete Tenant

📘

Return Type

  • Deletemessage//Response message.
  • GET/tenants/{tenant_id}/roles List Roles by Tenant

📘

Return Type

  • Deleteroles.id//ID of the Role. This is an auto generated and unique in the CoreStack system
  • Deleteroles.name//Name of the role. This is unique in the CoreStack system for a specific tenant
  • Deleteroles.status//Status of the Role
  • Deleteroles.access//List of access the role can perform in the tenant
  • Deleteroles.role_type//Type of the Role assigned to the user under a tenant
  • Deleteroles.users//Count of users having the role attached under a tenant
  • Deleteroles.description//Description of the role
  • Deleteroles.created_at//Date and time of role creation
  • Deleteroles.category//Category of the specific role. Either default or custom
  • Deleteroles.policies//List of policy available for a role
  • GET/tenants/{tenant_id}/users List Users by Tenant

📘

Return Type

  • Deleteusers.user_id//ID of the User. This is an auto generated and unique in the CoreStack system
  • Deleteusers.username//Username is unique in the CoreStack system. User can use this to login to CoreStack portal in addition to email
  • Deleteusers.status//Current Status of the user - active or inactive. Inactive user cannot login or use AccessKeys
  • Deleteusers.email//Email of the User. This is unique in the CoreStack system
  • Deleteusers.roles//List of roles assignments for the user. The same user can be assigned with different roles in a tenant
  • PUT/users/change_password/{user_id} Change Password

📘

Return Type

  • Deletestatus//Status of change password API call.
  • Deletemessage//Message of change password API call.
  • POST/users/create Create User

📘

Return Type

  • Deleteuser_id//ID of the newly created User
  • DELETE/users/delete/{user_id} Delete User

📘

Return Type

  • Deletemessage//Response message.
  • GET/users/filter-options List Users

📘

Return Type

  • Change tenants.cloud_providers.cloud (Added Enum)
  • Change tenants.cloud_providers.cloud_accounts.status (Added Enum, Removed Enum)
  • Change tenants.cloud_providers.cloud_accounts.scope (Added Enum, Removed Enum)
  • Change tenants.integrated_tool_providers.tool (Added Enum, Removed Enum)
  • Change tenants.integrated_tool_providers.tool_accounts.status (Added Enum, Removed Enum)
  • Change tenants.integrated_tool_providers.tool_accounts.scope (Added Enum, Removed Enum)