API Reference

External APIs (2503)

Changelog

What's New

  1. DELETE/budget/item/{budget_id} Delete Budget
  2. GET/budget/{budget_id}/budget_history List Budget History
  3. GET/budget/{budget_id}/view List Budget Detail
  4. PUT/budgets/threshold_alerts/update Update Budget Threshold Alerts
  5. POST/budgets/threshold_alerts/view View Budget Threshold Alerts
  6. POST/governance/guardrails/policies/batch List of policy details fetched for given policy uris or policy ids
  7. POST/operations/azure_patch_management/report/trigger Azure Patch Management Report Trigger
  8. POST/v1/agent/report/generate Schedule the generation of a report for Ai agent
  9. GET/v1/agent/report/item/{report_id} Fetch an Ai agent report by ID
  10. POST/v1/appsecops/applications/batch List of application details
  11. POST/v1/appsecops/applications/create Creates an application
  12. GET/v1/appsecops/applications/item/{application_id} Get the application details
  13. POST/v1/appsecops/applications/item/{application_id} Update an application
  14. POST/v1/appsecops/applications/list List of Applications
  15. POST/v1/appsecops/dashboard/summary/portfolio_hierarchy List all Portfolios along with its associated applications and projects
  16. POST/v1/appsecops/dashboard/summary/sbom_components List of all SBOMs along with its associated components
  17. POST/v1/appsecops/dashboard/summary/sbom_vulnerabilities List of all SBOM vulnerabilities
  18. POST/v1/appsecops/dashboard/summary/version_diff Summary of differences in vulnerability and component counts compared to the previous SBOM build
  19. POST/v1/appsecops/dashboard/top_actionable_issues List top (x) actionable issues including vulnerabilities, threats and config violations
  20. POST/v1/appsecops/dashboard/vulnerabilities/aggregation_by_component List of aggregated vulnerability count by component properties
  21. POST/v1/appsecops/dashboard/vulnerabilities/trend_by_severity List of vulnerabilities count by severity
  22. POST/v1/appsecops/portfolios/batch List of portfolio details
  23. POST/v1/appsecops/portfolios/create Creates a portfolio
  24. GET/v1/appsecops/portfolios/item/{portfolio_id} Get the portfolio details
  25. POST/v1/appsecops/portfolios/item/{portfolio_id} Update the portfolio details
  26. POST/v1/appsecops/portfolios/list List of portfolios
  27. POST/v1/appsecops/projects/batch List of project details
  28. POST/v1/appsecops/projects/create Creates a project
  29. GET/v1/appsecops/projects/item/{project_id} Get the project details
  30. POST/v1/appsecops/projects/item/{project_id} Update the project details
  31. POST/v1/appsecops/projects/list List of projects
  32. POST/v1/appsecops/sbom_components/batch List of sbom component details
  33. POST/v1/appsecops/sbom_definition/batch List of SBOM definition details
  34. POST/v1/appsecops/sbom_definition/create Creates a SBOM definition
  35. GET/v1/appsecops/sbom_definition/item/{sbom_id} Get SBOM definition details
  36. POST/v1/appsecops/sbom_definition/item/{sbom_id} Update SBOM definition details
  37. GET/v1/appsecops/sbom_definition/item/{sbom_id}/list_version List of versions for a SBOM definition
  38. POST/v1/appsecops/sbom_definition/list List of SBOM definitions
  39. POST/v1/appsecops/sbom_version/batch List of SBOM version details
  40. POST/v1/appsecops/sbom_version/create Creates a SBOM Version
  41. POST/v1/appsecops/sbom_version/diff/batch List of SBOM version difference details between the given SBOM version IDs and its corresponding predecessor version IDs
  42. GET/v1/appsecops/sbom_version/item/{version_id} Get SBOM version details
  43. POST/v1/appsecops/sbom_version/item/{version_id} Update SBOM version details
  44. DELETE/v1/appsecops/sbom_version/item/{version_id} Delete SBOM version
  45. POST/v1/appsecops/sbom_version/item/{version_id}/diff Fetch SBOM version component and vulnerability difference details
  46. GET/v1/appsecops/sbom_version/item/{version_id}/make-release Make SBOM version as the Release version
  47. POST/v1/appsecops/vulnerabilities/prevalence/organization List of organization(s) details where the vulnerabilities are prevalent
  48. POST/v1/secops/infra_threats/batch Details of the given batch of threat IDs
  49. POST/v1/secops/infra_threats/list Lists of threat IDs captured for cloud resources
  50. POST/v1/secops/infra_vulnerabilities/batch Details of the given batch of vulnerability IDs
  51. POST/v1/secops/infra_vulnerabilities/list List of vulnerability IDs captured for cloud resources
  52. POST/v1/secops/vulnerabilities/batch List of vulnerability details
  53. POST/v1/well-architected-framework/assessment/report/batch List of assessment run report details
  54. POST/v1/well-architected-framework/assessment/report/list Get a list of assessment run report ids for given filters
  55. POST/v2/billing/cost_and_usage/aggregation/trend Retrieves the aggregated trend of usage, rate and cost over a specified time period
  56. GET/v2/resources/{inventory_id}/dependent_resources Fetch all dependent resources

What's Decommissioned

  1. GET~~/budget/{tenant_id}/{budget_id}/budget_history~~ List Budget History
  2. DELETE~~/budget/{tenant_id}/{budget_id}/delete~~ Delete Budget
  3. GET~~/budget/{tenant_id}/{budget_id}/view~~ List Budget Detail
  4. PUT~~/{tenant_id}/budgets/threshold_alerts/update~ Update Budget Threshold Alerts
  5. POST~~/{tenant_id}/budgets/threshold_alerts/view~~ View Budget Threshold Alerts

What's Changed

  1. POST/budget/create Create Budget
    • Parameter
      • Add BudgetCreateUpdateRequest.budget_details.dimension//Dimension details for the budget. This is a unique ID and can be retrieved using the List Dimensions API.
      • Change BudgetCreateUpdateRequest.tenant_id
      • Change BudgetCreateUpdateRequest.budget_details.cloud_account_id
  2. POST/budget/dashboard/budget_alert_exceeds_count View Count Budget Alert Exceeds Summary
    • Parameter
      • Change BudgetSummaryRequest.filter_params.cloud_account_id
  3. POST/budget/dashboard/budget_summary_count View Count Budget Summary
    • Parameter
      • Change BudgetSummaryRequest.filter_params.cloud_account_id
  4. POST/budget/dashboard/list_budgets View Budget Dashboard
    • Parameter
      • Add BudgetListRequest.dimension_ids//Dimension IDs for the budget. This is a unique ID and can be retrieved using
      • Add BudgetListRequest.grouping_rule_ids//List of grouping rule IDs to be associated with the budget. This is a unique.
      • Change BudgetListRequest.cloud
      • Change BudgetListRequest.tenant_ids
    • Return Type
      • Add budgets_list.budget_scope_details.grouping_rule_ids
      • Add budgets_list.budget_scope_details.dimension_id
      • Add budgets_list.budget_scope_details.name//name of the budget scope
      • Add budgets_list.budget_scope_details.entity//entity type for the budget scope. This is a unique entity type and can be retrieved.
      • Add budgets_list.budget_scope_details.values
  5. PUT/budget/update Update Budget
    • Parameter
      • Add BudgetCreateUpdateRequest.budget_details.dimension//Dimension details for the budget. This is a unique ID and can be retrieved using the List Dimensions API.
      • Change BudgetCreateUpdateRequest.tenant_id
      • Change BudgetCreateUpdateRequest.budget_details.cloud_account_id
  6. POST/governance/guardrails/{tenant_id}/policies/batch List of policy details fetched for given policy uris
    • Parameter
      • Change PolicyDescriptionRequest.policy_uris
  7. POST/governance/guardrails/{tenant_id}/policies/list List Policies
    • Return Type
      • Change policies.scope
  8. GET/tenants List Tenant
    • Return Type
      • Add tenants.dimension_settings
  9. PUT/tenants/{tenant_id} Update Tenant
    • Parameter
      • Add UpdateTenantRequest.dimension_settings//Dimension Settings for this Tenant
  10. GET/users/filter-options List Users
    • Return Type
      • Add tenants.dimension_cost_centers.currency//Currency for the account
  11. POST/v1/agent/chat/item/{chat_id} Update the details of the chat
    • Parameter
      • Add AgentChatUpdateRequest.interrupt_conversation//Indicates if the conversation should be interrupted
  12. POST/v1/billing_plans/list Fetch all Billing Plan definitions for the user
    • Parameter
      • Add BillingPlanDefinitionListRequest.filters.raw_list_cost_adjusted_billing_plan//raw_list_cost_adjusted_billing_plan
  13. POST/v1/executive_dashboard_version/parseImport Parse Dashboard Definition Version
    • Return Type
      • Change flavor (Added Enum)
  14. GET/v1/feature_requirements/list List Feature requirements
    • Return Type
      • Change feature (Added Enum)
      • Change providers.mandatory_dependent_features
      • Change providers.optional_dependent_features
      • Change providers.ondemand_dependent_features
  15. GET/v1/products/list List Products
    • Return Type
      • Change name
      • Change features
  16. GET/v1/role_templates/list List Role Templates
    • Return Type
      • Change policies.policy (Added Enum)
  17. GET/v1/schedules/item/{schedule_id} Retrieve Schedule
    • Return Type
      • Add schedule_id//ID of the schedule
      • Add name//Schedule Name
      • Add category//Category of the schedule.
      • Add source//Source of the schedule creation
      • Add description//Description of the schedule
      • Add recurrence//Re-occurrence of the schedule
      • Add next_run//When will the schedule run for the next time
      • Add last_run//When the last schedule triggered
      • Add end_run//Upto when the schedule should run
      • Add schedule//Schedule date and time details
      • Add timezone//Timezone of the schedule
      • Add resource//ID of the resource which is scheduled. Can be retrieved using the respective List API
      • Add resource_args//Input Parameters for the resource that is scheduled which is a JSON string
      • Add execution_params//Execution parameters for the schedule.
      • Add notification_configuration//Notification configuration for the schedule.
      • Add is_active//Flag to represent whether the schedule is active or not.
      • Add is_system_schedule//Flag to represent whether the schedule is system scheduled or not.
      • Add tenant_id//Tenant owning the schedule.
      • Add created_at//When the schedule is created
      • Add created_by//Who has created the schedule
      • Add updated_at//When the schedule is updated
      • Add updated_by//Who has updated the schedule
      • Add background_job//Identity of the background job used for processing schedule. null if the job has completed
  18. POST/v1/tag_posture/snapshot/item/{snapshot_id}/resource_summary Summarize the tag posture matching the filtering criteria returning resource coverage counts
    • Parameter
      • Add TagPostureSummaryListRequest.filters.tag_key//Tag key to filter resources by, used to evaluate governance coverage for a specific tag like 'owner' or 'environment'.
  19. POST/v1/tag_posture/snapshot/item/{snapshot_id}/summary/cloud_account/list Returns a list of TagPostureCloudAccountSummary identifiers based on input filters
    • Parameter
      • Add TagPostureSummaryListRequest.filters.tag_key//Tag key to filter resources by, used to evaluate governance coverage for a specific tag like 'owner' or 'environment'.
  20. POST/v1/tag_posture/snapshot/item/{snapshot_id}/summary/resource/list Returns a list of TagPostureResourceSummary identifiers based on input filters
    • Parameter
      • Add TagPostureSummaryListRequest.filters.tag_key//Tag key to filter resources by, used to evaluate governance coverage for a specific tag like 'owner' or 'environment'.
  21. POST/v1/tag_posture/snapshot/item/{snapshot_id}/workload_summary/{workload_id}/resource/list Returns a batch of TagPostureWorkloadResourceSummary
    • Parameter
      • Add TagPostureSummaryListRequest.filters.tag_key//Tag key to filter resources by, used to evaluate governance coverage for a specific tag like 'owner' or 'environment'.
  22. DELETE/v1/waf-frameworks/{tenant_id}/best_practice/delete Framework Best Practice Delete
    • Parameter
      • Add WellArchitectedFrameworkBestPractice.is_automatable//Flag to indicate whether the best practice is automatable
  23. GET/v1/well-architected-framework/assessment/report/item/{report_id} Fetch an assessment run report by ID
    • Return Type
      • Add failure_message//Reason for report generation failure
      • Add status//Status of the report generation
      • Add triggered_at//TimeStamp when assessment run report generation was triggered
      • Add completed_at//TimeStamp when assessment run report generation was completed
  24. POST/v1/well-architected-framework/{tenant_id}/best-practice/batch Batch Best Practices
    • Return Type
      • Add is_automatable//Flag to indicate whether the best practice is automatable
  25. POST/v1/well-architected-framework/{tenant_id}/best-practice/create Best practices Create
    • Parameter
      • Add WellArchitectedFrameworkBestPracticeRequest.best_practices.is_automatable//Flag to indicate whether the best practice is automatable
  26. POST/v1/well-architected-framework/{tenant_id}/best-practice/update Best practice Update
    • Parameter
      • Add WellArchitectedFrameworkBestPractice.is_automatable//Flag to indicate whether the best practice is automatable
    • Return Type
      • Add is_automatable//Flag to indicate whether the best practice is automatable
  27. POST/v2/audit/auditlog/list Audit List
    • Parameter
      • Change AuditLogListRequest.filters.event_types
  28. POST/v2/billing/line_items_summary List values for group_by key used in service accounts
    • Parameter
      • Change BillingLineItemSummaryRequest.key.selector (Added Enum)
  29. GET/v2/reports/item/{report_id} Fetch a report by ID
    • Return Type
      • Add attachment_ids
      • Add status//Status of the report
      • Deleteattachment_id//ID of the attachment where the report contents are stored.
  30. POST/v2/service_account/create Create a new Service Account
    • Parameter
      • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)
  31. POST/v2/service_account/item/{service_account_id} Update Service Account details
    • Parameter
      • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)
    • Return Type
      • Change onboarded_features.feature (Added Enum)
  32. GET/v2/service_account/item/{service_account_id} Get Service Account details
    • Return Type
      • Change onboarded_features.feature (Added Enum)
  33. GET/v2/service_account/item/{service_account_id}/credentials_validation Validate Service Account Credentials
    • Return Type
      • Change onboarded_features.feature (Added Enum)
  34. POST/v2/service_account/item/{service_account_id}/dry_run Validate update of Service Account details
    • Parameter
      • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)
    • Return Type
      • Change onboarded_features.feature (Added Enum)
  35. POST/v2/service_account/item/{service_account_id}/extended_dry_run Validate update of Service Account details and check if the Governance Configuration can be accepted by the Cloud/Tool provider
    • Parameter
      • Change ServiceAccountDetails.onboarded_features.feature (Added Enum)
    • Return Type
      • Change onboarded_features.feature (Added Enum)
  36. POST/v2/service_account/list List Service Accounts
    • Parameter
      • Change ServiceAccountListRequest.filters.onboarded_any
      • Change ServiceAccountListRequest.filters.onboarded_all
  37. POST/v2/service_account/summary Summarize Service Accounts
    • Parameter
      • Change ServiceAccountSummaryRequest.filters.onboarded_any
      • Change ServiceAccountSummaryRequest.filters.onboarded_all

Changes Expected in Next Release

Refer to this link to know about the changes that can be expected in the next release -- https://docs.corestack.io/v5.2/docs/2504