External APIs 4.2 (2306)

Released November 22, 2023

Changelog

What's New

  • PUT/governance/account/{tenant_id}/cloud_account/{cloud_account_id}/update_policy_engine Updating Policy Engine
  • PUT/v1/background_job_handler/configuration Update the configuration of a Background Job Handler
  • POST/v1/background_job_handler/configuration Fetch the configuration of a Background Job Handler
  • POST/v1/background_job_handler/list Lists the active Background Job Handlers
  • GET/v1/custom_tags/cloud_account/{cloud_account_id} List CustomTags by Cloud Account
  • POST/v1/custom_tags/cloud_account/{cloud_account_id} Set CustomTags by Cloud Account
  • DELETE/v1/custom_tags/cloud_account/{cloud_account_id} Delete CustomTags by Cloud Account
  • GET/v1/custom_tags/master_account/{master_account_id} List CustomTags by Master Account
  • POST/v1/custom_tags/master_account/{master_account_id} Set CustomTags by Master Account
  • DELETE/v1/custom_tags/master_account/{master_account_id} Delete CustomTags by Master Account
  • GET/v1/custom_tags/tenant/{tenant_id} List CustomTags by Tenant
  • POST/v1/custom_tags/tenant/{tenant_id} Set CustomTags by Tenant
  • DELETE/v1/custom_tags/tenant/{tenant_id} Delete CustomTags by Tenant
  • POST/v1/runbook/{tenant_id}/AWS/automation/{document_id} Execute automation document
  • POST/v1/runbook/{tenant_id}/AWS/command/{document_id} Execute command document
  • DELETE/v1/runbook/{tenant_id}/AWS/command/{execution_id} Cancel command execution
  • POST/v1/runbook/{tenant_id}/AWS/documents/sync Manual document sync
  • GET/v1/runbook/{tenant_id}/AWS/execution/instance/list/{execution_id} List execution instances
  • GET/v1/security/notification/{cloud_account_id}/{sub_category} Get Security Notification Configuration
  • POST/v1/security/notification/{cloud_account_id}/{sub_category} Update Security Notification Configuration
  • DELETE/v1/waf-frameworks/{tenant_id}/best_practice/delete Framework Question Delete
  • DELETE/v1/waf-frameworks/{tenant_id}/pillar/delete Framework Pillar Delete
  • DELETE/v1/waf-frameworks/{tenant_id}/question/delete Framework Question Delete
  • POST/v2/audit/auditlog/batch Audit Detail
  • POST/v2/audit/auditlog/list Audit List
  • PUT/v2/reports/pin/{report_id} Create pinned report
  • GET/v2/reports/pinned/list List pinned report
  • PUT/v2/reports/unpin/{report_id} Delete pinned report
  • POST/v2/reports/user_view/create Create view of the report
  • POST/v2/reports/user_view/delete Delete view of the report
  • GET/v2/reports/user_view/list List of user report views
  • POST/v2/reports/user_view/update Update view of the report

What's Deprecated

Following APIs will be deprecated in 2307:

  • POST /resource/tags/{tenant_id}/tag_config_rule
  • DELETE /resource/tags/{tenant_id}/tag_config_rule
  • GET /resource/tags/{tenant_id}/list_tag_config_rules
  • POST /resource/tags/get_tag_keys
  • POST /resource/tags/{tenant_id}/get_tenant_resources
  • POST /operations/anomaly_detector/activity_insights/{tenant_id}/list
  • GET /operations/anomaly_detector/activity_insights/{tenant_id}/list_category
  • GET /operations/anomaly_detector/activity_insights/{tenant_id}/list_user
  • POST /operations/anomaly_detector/metric_anomalies/{tenant_id}/list
  • GET /operations/anomaly_detector/metric_anomalies/{tenant_id}/list_category
  • GET /operations/anomaly_detector/metric_anomalies/{tenant_id}/list_cloud_account
  • GET /operations/anomaly_detector/recommendations/{tenant_id}/list
  • POST /operations/anomaly_detector/recommendations/{tenant_id}/list_impacted_resources
  • GET /operations/anomaly_detector/recommendations/{tenant_id}/resolve
  • /compliance/{tenant_id}/compliance_standards/{cloud_account_id}/get_configurations

What's Changed

  • POST/budget/create Create Budget

    πŸ“˜

    Parameter

    • Change BudgetCreateUpdateReqModel.status
    • Change BudgetCreateUpdateReqModel.budget_event_type
  • PUT/budget/update Update Budget

    πŸ“˜

    Parameter

    • Change BudgetCreateUpdateReqModel.status
    • Change BudgetCreateUpdateReqModel.budget_event_type
  • POST/governance/account/{tenant_id}/cloud_account/{cloud_account_id}/config_validation Config Validation Details

    πŸ“˜

    Parameter

    • Change ConfigValidationRequest.policy_engine
    • Change ConfigValidationRequest.service_name

    πŸ“˜

    Return Type

    • Add config_validations//Config validation results
    • Deleteconfig_validation//config validation either null or {}
    • Change status
    • Change mandatory_requirements
    • Change optional_requirements
  • POST/governance/account/{tenant_id}/create/cloud_accounts On-board Cloud Accounts

    πŸ“˜

    Parameter

    • Change CloudAccountCreateRequestModel.scope (Removed Enum)
  • PUT/governance/account/{tenant_id}/update/{cloud_account_id} Update Cloud Account

    πŸ“˜

    Parameter

    • Change CloudAccountUpdateRequestModel.scope (Removed Enum)
  • PUT/governance/account/{tenant_id}/update/{parent_account_id}/onboard_csp_subscription On-Boarding CSP Subscription

    πŸ“˜

    Parameter

    • Change CSPOnboardSubscriptionRequestModel.scope (Removed Enum)
  • POST/governance/guardrails/policies/{tenant_id}/create Create Policy Schedules

    πŸ“˜

    Parameter

    • Add UpdateScheduleRequest.recurrence//Recurrence of the schedule
  • PUT/governance/guardrails/policies/{tenant_id}/update/{schedule_id} Update Policy Schedules

    πŸ“˜

    Parameter

    • Add UpdateScheduleRequest.recurrence//Recurrence of the schedule
  • POST/operations/automation/scripts/{tenant_id}/create Create Script Schedules

    πŸ“˜

    Parameter

    • Add UpdateScheduleRequestScript.recurrence//Recurrence of the schedule
  • PUT/operations/automation/scripts/{tenant_id}/update/{schedule_id} Update Script Schedules

    πŸ“˜

    Parameter

    • Add UpdateScheduleRequestScript.recurrence//Recurrence of the schedule
  • POST/operations/automation/templates/{tenant_id}/create Create Template Schedules

    πŸ“˜

    Parameter

    • Add UpdateScheduleRequest.recurrence//Recurrence of the schedule
  • PUT/operations/automation/templates/{tenant_id}/update/{schedule_id} Update Template Schedules

    πŸ“˜

    Parameter

    • Add UpdateScheduleRequest.recurrence//Recurrence of the schedule
  • PUT/tenants/{tenant_id} Update Tenant

    πŸ“˜

    Parameter

    • Change UpdateTenantRequest.account_id
  • POST/v1/integrations/servicenow/cmdb_sync/trigger Trigger CMDB sync

    πŸ“˜

    Parameter

    • Add ServiceNowCmdbSyncRequest.update_configuration_for_existing_records//Configuration update flag
  • GET/v1/master_accounts/item/{master_account_id} Master Account View

    πŸ“˜

    Return Type

    • Change custom_tags
  • POST/v1/runbook/{tenant_id}/AWS/documents/execution/list List executions

    πŸ“˜

    Parameter

    • Add AwsSsmListDocumentExecutionRequest.filters.query_filter
  • POST/v1/runbook/{tenant_id}/AWS/documents/list List Documents

    πŸ“˜

    Parameter

    • Add AwsSsmListDocumentsRequest.filters.query_filter
  • POST/v1/tag_posture/snapshot/item/{snapshot_id}/summary/cloud_account/list Returns a list of TagPostureCloudAccountSummary identifiers based on input filters

    πŸ“˜

    Parameter

    • Change TagPostureSummaryListRequest.sort.column (Added Enum)
  • POST/v1/tag_posture/snapshot/item/{snapshot_id}/summary/resource/list Returns a list of TagPostureResourceSummary identifiers based on input filters

    πŸ“˜

    Parameter

    • Change TagPostureSummaryListRequest.sort.column (Added Enum)
  • GET/v1/user_details Get User session and roles details

    πŸ“˜

    Return Type

    • Add tenants.is_default//If user created under particular tenant it will be set to True or else False
  • POST/v1/well-architected-framework/assessment-definition/batch Get Dashboard Versions

    πŸ“˜

    Return Type

    • Add notification_configuration
  • POST/v1/well-architected-framework/assessment-definition/create Create new Assessment

    πŸ“˜

    Return Type

    • Add notification_configuration
  • GET/v1/well-architected-framework/assessment-definition/item/{assessment_id} Get Assessment Definition

    πŸ“˜

    Return Type

    • Add notification_configuration
  • POST/v1/well-architected-framework/assessment-definition/item/{assessment_id}/set-state Set state of Assessment Definition

    πŸ“˜

    Parameter

    • Add WellArchitectedFrameworkAssessmentDefinition.notification_configuration

    πŸ“˜

    Return Type

    • Add notification_configuration
  • POST/v1/well-architected-framework/assessment-definition/list Filter Assessment Definitions

    πŸ“˜

    Parameter

    • Add AssessmentDefinitionListRequest.sort//Sort criteria
    • Add AssessmentDefinitionListRequest.filters.query
  • POST/v1/well-architected-framework/assessment-run-report/create Schedule the generation of a report for an assessment run

    πŸ“˜

    Parameter

    • Add WellArchitectedFrameworkReportCreateRequest.assessment_run_history//ID of the assessment run history
    • Add WellArchitectedFrameworkReportCreateRequest.report_type//Type of Well Architected report
    • DeleteWellArchitectedFrameworkReportCreateRequest.assessment_run_history_id//ID of the assessment run history
  • POST/v1/well-architected-framework/assessment-run-report/item/{report_id} Fetch an assessment run report by ID

    πŸ“˜

    Return Type

    • Add framework_id//Identity of the Framework
  • POST/v1/well-architected-framework/{tenant_id}/best-practice/batch Batch Best Practices

    πŸ“˜

    Return Type

    • Change risk
  • POST/v1/well-architected-framework/{tenant_id}/best-practice/create Best practices Create

    πŸ“˜

    Parameter

    • Change WellArchitectedFrameworkBestPracticeRequest.best_practices.risk
  • POST/v1/well-architected-framework/{tenant_id}/best-practice/update Best practice Update

    πŸ“˜

    Parameter

    • Change WellArchitectedFrameworkBestPractice.risk

    πŸ“˜

    Return Type

    • Change risk
  • GET/v1/workload-definition/item/{workload_id}/history Get the history of a Workload Definition

    πŸ“˜

    Return Type

    • Deletedetails.tags.key//Key of the workload tag
    • Deletedetails.tags.value//Value of the workload tag
  • POST/v1/workload-definition/list Filter Workload Definitions

    πŸ“˜

    Parameter

    • Add WorkloadDefinitionListRequest.sort//Sort criteria
    • Add WorkloadDefinitionListRequest.filters.query
  • GET/v1/workload-query/resource/filters/service-resource Returns list of WorkloadServiceResource with all possible filter values

    πŸ“˜

    Return Type

    • Add supports_tags//Whether resource has tag support
  • POST/v1/workload-version/batch Get Workload Versions

    πŸ“˜

    Return Type

    • Deletedetails.tags.key//Key of the workload tag
    • Deletedetails.tags.value//Value of the workload tag
  • POST/v1/workload-version/create Create new Workload Definition Version

    πŸ“˜

    Parameter

    • DeleteWorkloadDefinitionVersion.details.tags.key//Key of the workload tag
    • DeleteWorkloadDefinitionVersion.details.tags.value//Value of the workload tag

    πŸ“˜

    Return Type

    • Deletedetails.tags.key//Key of the workload tag
    • Deletedetails.tags.value//Value of the workload tag
  • GET/v1/workload-version/item/{version_id} Get Workload Definition Version

    πŸ“˜

    Return Type

    • Deletedetails.tags.key//Key of the workload tag
    • Deletedetails.tags.value//Value of the workload tag
  • GET/v1/workload-version/item/{version_id}/make-head Make Workload Definition Version the Head version

    πŸ“˜

    Return Type

    • Deletedetails.tags.key//Key of the workload tag
    • Deletedetails.tags.value//Value of the workload tag
  • GET/v1/workload-version/item/{version_id}/make-release Make Workload Definition Version the Release version

    πŸ“˜

    Return Type

    • Deletedetails.tags.key//Key of the workload tag
    • Deletedetails.tags.value//Value of the workload tag
  • POST/v1/workload-version/parseImport Parse Workload Definition Version

    πŸ“˜

    Return Type

    • Deletetags.key//Key of the workload tag
    • Deletetags.value//Value of the workload tag