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

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

Suggest Edits

What's Changed

  • POST/users/forget_password/{user_id} Forget Password

📘

Return Type

  • Deletestatus//Status of forget password API call.
  • Deletemessage//Message of forget password API call. message.
  • GET/users/profile/{user_id} View User Profile

📘

Return Type

  • Deletemessage//Message of profile API call
  • POST/users/{user_id}/activate_user/{auth_token} Activate User

📘

Parameter

  • Add ActivateRequest
  • DeleteActivateRequestModel
  • POST/v1/auth/tokens/refresh Get Refresh Token

📘

Parameter

  • Add RefreshTokenRequest
  • DeleteRefreshTokenRequestModel
  • POST/v1/aws-security-hub/dashboard/findings/list Returns a list AWS Security Hub Findings ids

📘

Parameter

  • Change AwsSecurityHubFindingListRequest.filters.filters.clouds
  • POST/v1/cost/costoptimizer/optimizerate/long_term_savings/recommended_reservations/savings_summary Saving Summary for Recommended Reservations

📘

Parameter

  • Change RecommendedReservationsSavingsSummaryRequest.services
  • POST/v1/cost/tags/list Returns a list of CostTag ids

📘

Parameter

  • Change CostTagListRequest.filters.clouds
  • POST/v1/integrations/servicenow/cmdb_config/list_inventory_attributes List Inventory Attributes for Resource

📘

Parameter

  • Change ServiceNowCmdbViewInventorySchemaRequest.service_name (Added Enum)
  • POST/v1/integrations/servicenow/cmdb_config/view_hierarchy View Cloud Schema Hierarchy

📘

Parameter

  • Add ServiceNowCmdbCloudSchemaRequest.monitoring_support_schema//flag to return inventory hierarchy for monitoring support resources
  • Change ServiceNowCmdbCloudSchemaRequest.service_name (Added Enum)
  • POST/v1/master_accounts

📘

Parameter

  • Add CreateMasterAccountRequest.products//Products to enable
  • DeleteCreateMasterAccountRequest.is_full_access
  • DeleteCreateMasterAccountRequest.product_bundles//Product Bundle List
  • DeleteCreateMasterAccountRequest.cost_settings//Discount config info
  • DeleteCreateMasterAccountRequest.supported_bundles//Supported Bundle List
  • DELETE/v1/master_accounts/item/{master_account_id} Master Account Delete

📘

Return Type

  • Deletemessage//Response message.
  • GET/v1/master_accounts/item/{master_account_id} Master Account View

📘

Return Type

  • Add products//Products enabled in the master account
  • Deleteis_full_access//Whether full access or not.
  • Deletecost_settings//Discount config info
  • Deletemetadata//Additional metadata information of master account
  • POST/v1/tag_baseline/batch Get Baselines

📘

Return Type

  • Add title//Name of the baseline
  • Add description//Description of the baseline
  • Add scope//At what scope level the baseline should work
  • POST/v1/tag_baseline/create Create new Tag Baseline

📘

Return Type

  • Add title//Name of the baseline
  • Add description//Description of the baseline
  • Add scope//At what scope level the baseline should work
  • GET/v1/tag_baseline/item/{baseline_id} Get Tag Baseline Definition

📘

Return Type

  • Add title//Name of the baseline
  • Add description//Description of the baseline
  • Add scope//At what scope level the baseline should work
  • GET/v1/tag_baseline/item/{baseline_id}/history Get the history of a Tag Baseline Definition

📘

Return Type

  • Deletedetails.title//Name of the baseline
  • Deletedetails.description//Description of the baseline
  • Deletedetails.scope//At what scope level the baseline should work
  • POST/v1/tag_baseline_version/batch Get Dashboard Versions

📘

Return Type

  • Deletedetails.title//Name of the baseline
  • Deletedetails.description//Description of the baseline
  • Deletedetails.scope//At what scope level the baseline should work
  • POST/v1/tag_baseline_version/create Create new Tag Baseline Definition Version

📘

Parameter

  • DeleteTagBaselineDefinitionVersion.details.title//Name of the baseline
  • DeleteTagBaselineDefinitionVersion.details.description//Description of the baseline
  • DeleteTagBaselineDefinitionVersion.details.scope//At what scope level the baseline should work

📘

Return Type

  • Deletedetails.title//Name of the baseline
  • Deletedetails.description//Description of the baseline
  • Deletedetails.scope//At what scope level the baseline should work
  • GET/v1/tag_baseline_version/item/{version_id} Get Tag Baseline Definition Version

📘

Return Type

  • Deletedetails.title//Name of the baseline
  • Deletedetails.description//Description of the baseline
  • Deletedetails.scope//At what scope level the baseline should work
  • GET/v1/tag_baseline_version/item/{version_id}/make-head Make Tag Baseline Definition Version the Head version

📘

Return Type

  • Deletedetails.title//Name of the baseline
  • Deletedetails.description//Description of the baseline
  • Deletedetails.scope//At what scope level the baseline should work
  • GET/v1/tag_baseline_version/item/{version_id}/make-release Make Tag Baseline Definition Version the Release version

📘

Return Type

  • Deletedetails.title//Name of the baseline
  • Deletedetails.description//Description of the baseline
  • Deletedetails.scope//At what scope level the baseline should work
  • POST/v1/tag_baseline_version/parseImport Parse Tag Baseline Definition Version

📘

Return Type

  • Deletetitle//Name of the baseline
  • Deletedescription//Description of the baseline
  • Deletescope//At what scope level the baseline should work
  • POST/v1/tag_baselines/available_tags/batch Returns a batch of AvailableTag

📘

Parameter

  • Add TagBaselineAvailableTagBatchRequest
  • DeleteBatchRequest
  • POST/v1/tag_baselines/available_tags/list Returns a list of AvailableTags ids

📘

Parameter

  • Change TagBaselineAvailableTagListRequest.filters.filters.clouds
  • 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.filters.filter.clouds
  • POST/v1/tag_posture/snapshot/item/{snapshot_id}/summary/resource/list Returns a list of TagPostureResourceSummary identifiers based on input filters

📘

Parameter

  • Change TagPostureSummaryListRequest.filters.filter.clouds
  • GET/v1/user/switch_account/{master_account_id} Switch Master Account

📘

Return Type

  • Add auth_type//Authentication type.
  • Add require_access_key//Whether access key required.
  • Add workflow//Workflow details
  • Add auth_method//Authentication method.
  • Add cost_unit//Constant unit.
  • Add is_full_access//Whether full access or not.
  • Add subscription_details//Subscription details.
  • Add dashboard_reference//Dashboard reference.
  • Add payment//Payment list.
  • Add is_product_admin//Whether Product admin or not.
  • Add cost_currency//Cost currency.
  • Add footer_text//Footer text.
  • Deletelicense_expiry//License Expiry
  • Change account_id
  • Change is_account_admin
  • Change alias
  • Change audit
  • DELETE/v1/user_delegation/master_accounts/{master_account_id}/rules/item/{rule_id} Delete User Delegation

📘

Return Type

  • Deletemessage//Response message.
  • GET/v1/user_details Get User session and roles details

📘

Return Type

  • Deletesupported_pillars//Supported pillars.
  • POST/v1/user_preferences/{user_id}/value/get Get details of the user preference

📘

Return Type

  • Add updated_at//When the user preference was updated
  • Deleteupdate_at//When the user preference was updated
  • POST/v1/user_preferences/{user_id}/value/list List all user preferences

📘

Return Type

  • Add names//Map from name to last update timestamp
  • POST/v1/user_preferences/{user_id}/value/set Create a new user preference

📘

Parameter

  • Add UserPreference.updated_at//When the user preference was updated
  • DeleteUserPreference.update_at//When the user preference was updated

📘

Return Type

  • Add updated_at//When the user preference was updated
  • Deleteupdate_at//When the user preference was updated
  • GET/v1/well-architected-framework/assessment-definition/item/{assessment_id}/history Get the history of an Assessment Definition

📘

Return Type

  • Deletedetails.sync_with_hyperscaler.AWS.cloud_account_id//ID of cloud account
  • Deletedetails.sync_with_hyperscaler.AWS.region//Name of region
  • POST/v1/well-architected-framework/assessment-definition/list Filter Assessment Definitions

📘

Parameter

  • Change AssessmentDefinitionListRequest.sort.column (Added Enum)
  • POST/v1/well-architected-framework/assessment-run-report/create Schedule the generation of a report for an assessment run

📘

Parameter

  • Change WellArchitectedFrameworkReportCreateRequest.report_type (Added Enum)
  • POST/v1/well-architected-framework/assessment-version/batch Get Assessment Versions

📘

Return Type

  • Deletedetails.sync_with_hyperscaler.AWS.cloud_account_id//ID of cloud account
  • Deletedetails.sync_with_hyperscaler.AWS.region//Name of region
  • POST/v1/well-architected-framework/assessment-version/create Create new Assessment Definition Version

📘

Parameter

  • DeleteWellArchitectedFrameworkAssessmentDefinitionVersion.details.sync_with_hyperscaler.AWS.cloud_account_id//ID of cloud account
  • DeleteWellArchitectedFrameworkAssessmentDefinitionVersion.details.sync_with_hyperscaler.AWS.region//Name of region

📘

Return Type

  • Deletedetails.sync_with_hyperscaler.AWS.cloud_account_id//ID of cloud account
  • Deletedetails.sync_with_hyperscaler.AWS.region//Name of region
  • GET/v1/well-architected-framework/assessment-version/item/{version_id} Get Assessment Definition Version

📘

Return Type

  • Deletedetails.sync_with_hyperscaler.AWS.cloud_account_id//ID of cloud account
  • Deletedetails.sync_with_hyperscaler.AWS.region//Name of region
  • GET/v1/well-architected-framework/assessment-version/item/{version_id}/make-head Make Assessment Definition Version the Head version

📘

Return Type

  • Deletedetails.sync_with_hyperscaler.AWS.cloud_account_id//ID of cloud account
  • Deletedetails.sync_with_hyperscaler.AWS.region//Name of region
  • GET/v1/well-architected-framework/assessment-version/item/{version_id}/make-release Make Assessment Definition Version the Release version

📘

Return Type

  • Deletedetails.sync_with_hyperscaler.AWS.cloud_account_id//ID of cloud account
  • Deletedetails.sync_with_hyperscaler.AWS.region//Name of region
  • GET/v1/well-architected-framework/assessment-version/item/{version_id}/set-state Set state of Assessment Definition Version

📘

Return Type

  • Deletedetails.sync_with_hyperscaler.AWS.cloud_account_id//ID of cloud account
  • Deletedetails.sync_with_hyperscaler.AWS.region//Name of region
  • POST/v1/well-architected-framework/assessment-version/parseImport Parse Assessment Definition Version

📘

Return Type

  • Deletesync_with_hyperscaler.AWS.cloud_account_id//ID of cloud account
  • Deletesync_with_hyperscaler.AWS.region//Name of region
  • POST/v1/well-architected-framework/{tenant_id}/framework/batch Batch Frameworks

📘

Return Type

  • Change valid_service_types
  • POST/v1/well-architected-framework/{tenant_id}/framework/create Framework Create

📘

Parameter

  • Change WellArchitectedFramework.valid_service_types

📘

Return Type

  • Change valid_service_types
  • POST/v1/well-architected-framework/{tenant_id}/framework/update Framework Update

📘

Parameter

  • Change WellArchitectedFramework.valid_service_types

📘

Return Type

  • Change valid_service_types
  • POST/v1/workload-definition/list Filter Workload Definitions

📘

Parameter

  • Change WorkloadDefinitionListRequest.sort.column (Added Enum)
  • GET/v1/workload-query/resource/filters/service-resource Returns list of WorkloadServiceResource with all possible filter values

📘

Return Type

  • Change cloud (Added Enum)
  • POST/v2/audit/auditlog/list Audit List

📘

Parameter

  • Change AuditLogListRequest.filters.event_types
  • Change AuditLogListRequest.filters.event_actions
  • POST/v2/security/executive_dashboard/access/by_cloud_account Get Access Violation by Cloud Account

📘

Parameter

  • Change SecurityDashboardRequest.filter.clouds

📘

Return Type

  • Change cloud_provider (Added Enum)
  • POST/v2/security/executive_dashboard/access/by_region Get Access Violation By Region

📘

Parameter

  • Change SecurityDashboardRequest.filter.clouds

📘

Return Type

  • Change cloud_provider (Added Enum)
  • POST/v2/security/executive_dashboard/access/trend_by_severity Get Access Violation trend by severity

📘

Parameter

  • Change SecurityDashboardRequest.filter.clouds
  • PUT/{tenant_id}/budgets/threshold_alerts/update Update Budget Threshold Alerts

📘

Parameter

  • Add ThresholdAlertUpdateRequest
  • DeleteThresholdAlertUpdateReqModel
  • POST/{tenant_id}/budgets/threshold_alerts/view View Budget Threshold Alerts

📘

Parameter

  • Add ThresholdAlertViewListRequest
  • DeleteThresholdAlertViewListReqModel

Updated 3 months ago