Guides

External APIs 4.5 (2403)

Released - October 2024

Suggest Edits

Changelog

What's New

  1. GET/v1/policy/configuration/policy/{policy_id}/tenant/{tenant_id}/service_account_list List accounts for policy configuration
  2. GET/v1/policy/configuration/{policy_id}/service_account/{service_account_id} Get Policy parameter configuration Account
  3. POST/v1/policy/configuration/{policy_id}/service_account/{service_account_id} Update Policy parameter configuration Account
  4. DELETE/v1/policy/configuration/{policy_id}/service_account/{service_account_id} Delete Policy parameter configuration Account
  5. POST/v1/policy/configuration/{policy_id}/service_account_batch Get account policy configuration batch
  6. GET/v1/policy/configuration/{policy_id}/tenant/{tenant_id} Get Policy parameter configuration tenant
  7. POST/v1/policy/configuration/{policy_id}/tenant/{tenant_id} Update Policy parameter configuration Tenant
  8. DELETE/v1/policy/configuration/{policy_id}/tenant/{tenant_id} Delete Policy parameter configuration Tenant
  9. POST/v1/resource/tags/bulk_remediation Create Bulk Resource Tag Remediation
  10. POST/v1/resource/tags/bulk_remediation_status Return bulk Resource Tag Remediation Status
  11. POST/v1/resource/tags/remediation/{tenant_id} Create Resource Tag Remediation
  12. POST/v1/resource/virtual_machine_agents/batch Batch VM Agents Details
  13. POST/v1/resource/virtual_machine_agents/list List VM Agents Details
  14. POST/v1/schedules/batch Fetch a batch of schedules
  15. POST/v1/schedules/create Creates a Schedule
  16. GET/v1/schedules/item/{schedule_id} Retrieve Schedule
  17. POST/v1/schedules/item/{schedule_id} Updates a Schedule
  18. DELETE/v1/schedules/item/{schedule_id} Delete Schedule
  19. POST/v1/schedules/item/{schedule_id}/set_next_execution Set Next Execution of a Schedule
  20. GET/v1/schedules/item/{schedule_id}/skip_next_execution Skip next execution of a Schedule
  21. POST/v1/schedules/list List Schedules of given category
  22. POST/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/cost-estimate Initiates the cost estimation of a deployment run that could happen on a service account
  23. GET/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/cost-estimate/{background_job_id}/status Gets the cost estimation of a deployment run that could happen on a service account
  24. POST/v1/tag_posture/snapshot/item/{snapshot_id}/resource/batch Returns a batch of TagPostureResources
  25. POST/v1/tag_posture/snapshot/item/{snapshot_id}/resource_summary Summarize the tag posture matching the filtering criteria returning resource coverage counts
  26. GET/v1/tag_posture/snapshot/item/{snapshot_id}/workload_summary/{workload_id} Get a TagPostureSummary for Workload
  27. POST/v1/tag_posture/snapshot/item/{snapshot_id}/workload_summary/{workload_id}/resource/list Returns a batch of TagPostureWorkloadResourceSummary

What's Decommissioned

  1. GET /governance/account/{tenant_id}/validate_summary Cloud Accounts Summary
  2. POST /operations/activity/{tenant_id}/create Create New Activity Configuration
  3. GET /operations/activity/{tenant_id}/get_configuration_summary Get Activity Configuration Summary
  4. GET /operations/activity/{tenant_id}/get_notification/{cloud_account_id} Get Notification Based on Activity Configuration
  5. GET /operations/activity/{tenant_id}/list/{cloud_account_id} List Activities Based on Activity Configuration
  6. PUT /operations/activity/{tenant_id}/update/{cloud_account_id}/{action_name} Update Activity Configuration
  7. PUT /operations/activity/{tenant_id}/{cloud_account_id}/update/{activity_id}/{action_name} Update Activity Configuration Details
  8. POST /resource/tags/{tenant_id}/remediation Create Resource Tag Remediation
  9. POST /resource/tags/{tenant_id}/remediation_status/{cloud} Get Resource Tag Remediation Status
  10. POST /v1/well-architected-framework/{tenant_id}/policy-params/get Get execution parameters for policy mapped to WAF framework
  11. POST /v1/well-architected-framework/{tenant_id}/policy-params/set Configure execution parameters for policy mapped to WAF framework

What's Changed

  1. POST/cost/executive_dashboard/cloud_forecaster_for_six_months Get cloud Forecaster for six months
    • Parameter
      • Add CloudForecasterForSixMonthsRequest.filter.resource_filter//Resources filter to filter (all if missing)
  2. POST/cost/executive_dashboard/cost_optimization_by_optimization_types cost optimization by optimization type
    • Parameter
      • Add CostOptimizationByOptimizationTypesRequest.filter.resource_filter//Resources filter to filter (all if missing)
  3. POST/cost/executive_dashboard/cost_optimization_trend Get cost optimization trend
    • Parameter
      • Add CostOptimizationTrendRequest.filter.resource_filter//Resources filter to filter (all if missing)
  4. POST/cost_anomaly/billing_cost_anomaly Get Account wise daily Billing Cost Anomaly
    • Parameter
      • Add CostAnomalySummaryRequest.filter.resource_filter//Resources filter to filter (all if missing)
  5. POST/governance/guardrails/policies/{tenant_id}/create Create Policy Schedules
    • Parameter
      • Add UpdateScheduleRequest.attributes.service_accounts//Service account id is unique can be obtained from the list cloud
      • Delete UpdateScheduleRequest.attributes.cloud_account//Cloud account id is unique can be obtained from the list cloud
  6. PUT/governance/guardrails/policies/{tenant_id}/update/{schedule_id} Update Policy Schedules
    • Parameter
      • Add UpdateScheduleRequest.attributes.service_accounts//Service account id is unique can be obtained from the list cloud
      • Delete UpdateScheduleRequest.attributes.cloud_account//Cloud account id is unique can be obtained from the list cloud
  7. GET/operation/automation/scripts/{tenant_id} List Scripts
    • Return Type
      • Change scripts.platform
  8. POST/operation/automation/scripts/{tenant_id} Create Script
    • Parameter
      • Change CreateScriptRequest.platform
  9. POST/operation/automation/scripts/{tenant_id}/execute Execute Script
    • Parameter
      • Add ExecuteScriptRequest.job_details//Execution input such as script/host details
      • Delete ExecuteScriptRequest.host_details//Execution input such as script/host details
  10. PUT/operation/automation/{tenant_id}/scripts/{script_id} Update Script
    • Parameter
      • Change CreateScriptRequest.platform
  11. GET/operation/automation/{tenant_id}/scripts/{script_id} Describe Script
    • Return Type
      • Change platform
  12. POST/operations/automation/scripts/{tenant_id}/create Create Script Schedules
    • Parameter
      • Add UpdateScheduleRequestScript.attributes.service_accounts//Service account id is unique can be obtained from the list cloud
      • Delete UpdateScheduleRequestScript.attributes.cloud_account//Cloud account id is unique can be obtained from the list cloud
  13. PUT/operations/automation/scripts/{tenant_id}/update/{schedule_id} Update Script Schedules
    • Parameter
      • Add UpdateScheduleRequestScript.attributes.service_accounts//Service account id is unique can be obtained from the list cloud
      • Delete UpdateScheduleRequestScript.attributes.cloud_account//Cloud account id is unique can be obtained from the list cloud
  14. POST/operations/automation/templates/{tenant_id}/create Create Template Schedules
    • Parameter
      • Add UpdateScheduleRequest.attributes.service_accounts//Service account id is unique can be obtained from the list cloud
      • Delete UpdateScheduleRequest.attributes.cloud_account//Cloud account id is unique can be obtained from the list cloud
  15. PUT/operations/automation/templates/{tenant_id}/update/{schedule_id} Update Template Schedules
    • Parameter
      • Add UpdateScheduleRequest.attributes.service_accounts//Service account id is unique can be obtained from the list cloud
      • Delete UpdateScheduleRequest.attributes.cloud_account//Cloud account id is unique can be obtained from the list cloud
  16. POST/v1/aws-security-hub/dashboard/findings/list Returns a list AWS Security Hub Findings ids
    • Parameter
      • Add AwsSecurityHubFindingListRequest.filters.filters.resource_filter//Resources filter to filter (all if missing)
  17. POST/v1/cost/tags/list Returns a list of CostTag ids
    • Parameter
      • Add CostTagListRequest.filters.resource_filter//Resources filter to filter (all if missing)
  18. POST/v1/executive_dashboard/batch Get Dashboard Definitions
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete user
      • Delete headVersion
      • Delete releaseVersion
  19. POST/v1/executive_dashboard/create Create new Dashboard Definition
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete user
      • Delete headVersion
      • Delete releaseVersion
  20. GET/v1/executive_dashboard/item/{dashboard_id} Get Dashboard Definition
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete user
      • Delete headVersion
      • Delete releaseVersion
  21. GET/v1/executive_dashboard/item/{dashboard_id}/history Get the history of a Dashboard Definition
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete version
      • Delete definition
      • Delete details
      • Delete predecessor
  22. POST/v1/executive_dashboard_version/batch Get Dashboard Versions
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete version
      • Delete definition
      • Delete details
      • Delete predecessor
  23. POST/v1/executive_dashboard_version/create Create new Dashboard Definition Version
    • Parameter
      • Delete DashboardDefinitionVersion.sysId
      • Delete DashboardDefinitionVersion.createdOn
      • Delete DashboardDefinitionVersion.updatedOn
      • Delete DashboardDefinitionVersion.version
      • Delete DashboardDefinitionVersion.definition
      • Delete DashboardDefinitionVersion.details
      • Delete DashboardDefinitionVersion.predecessor
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete version
      • Delete definition
      • Delete details
      • Delete predecessor
  24. GET/v1/executive_dashboard_version/item/{version_id} Get Dashboard Definition Version
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete version
      • Delete definition
      • Delete details
      • Delete predecessor
  25. GET/v1/executive_dashboard_version/item/{version_id}/make-head Make Dashboard Definition Version the Head version
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete version
      • Delete definition
      • Delete details
      • Delete predecessor
  26. GET/v1/executive_dashboard_version/item/{version_id}/make-release Make Dashboard Definition Version the Release version
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete version
      • Delete definition
      • Delete details
      • Delete predecessor
  27. GET/v1/role_templates/list List Role Templates
    • Return Type
      • Change policies.policy (Added Enum)
  28. POST/v1/stacks-marketplace/stack-deployment/item/{stack_deployment_id}/execute Execute Stacks Marketplace Stack Deployment
    • Parameter
      • Add StackMarketplaceStackDeploymentExecute.estimated_cost//Estimated cost of the stack before deployment.
    • Return Type
      • Add estimated_cost//Estimated cost of the stack before deployment.
  29. POST/v1/tag_baseline/batch Get Baselines
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete account_id//Account owning the tag baseline
      • Delete headVersion
      • Delete releaseVersion
      • Delete title//Name of the baseline
      • Delete description//Description of the baseline
      • Delete scope//At what scope level the baseline should work
      • Delete is_active//States if the baseline definition is active or not
  30. POST/v1/tag_baseline/create Create new Tag Baseline
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete account_id//Account owning the tag baseline
      • Delete headVersion
      • Delete releaseVersion
      • Delete title//Name of the baseline
      • Delete description//Description of the baseline
      • Delete scope//At what scope level the baseline should work
      • Delete is_active//States if the baseline definition is active or not
  31. GET/v1/tag_baseline/item/{baseline_id} Get Tag Baseline Definition
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete account_id//Account owning the tag baseline
      • Delete headVersion
      • Delete releaseVersion
      • Delete title//Name of the baseline
      • Delete description//Description of the baseline
      • Delete scope//At what scope level the baseline should work
      • Delete is_active//States if the baseline definition is active or not
  32. GET/v1/tag_baseline/item/{baseline_id}/history Get the history of a Tag Baseline Definition
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete version
      • Delete definition
      • Delete details
      • Delete predecessor
  33. POST/v1/tag_baseline/item/{baseline_id}/set-state Set state of Tag Baseline Definition
    • Parameter
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete account_id//Account owning the tag baseline
      • Delete headVersion
      • Delete releaseVersion
      • Delete title//Name of the baseline
      • Delete description//Description of the baseline
      • Delete scope//At what scope level the baseline should work
      • Delete is_active//States if the baseline definition is active or not
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete account_id//Account owning the tag baseline
      • Delete headVersion
      • Delete releaseVersion
      • Delete title//Name of the baseline
      • Delete description//Description of the baseline
      • Delete scope//At what scope level the baseline should work
      • Delete is_active//States if the baseline definition is active or not
  34. POST/v1/tag_baseline_version/batch Get Dashboard Versions
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete version
      • Delete definition
      • Delete details
      • Delete predecessor
  35. POST/v1/tag_baseline_version/create Create new Tag Baseline Definition Version
    • Parameter
      • Delete TagBaselineDefinitionVersion.sysId
      • Delete TagBaselineDefinitionVersion.createdOn
      • Delete TagBaselineDefinitionVersion.updatedOn
      • Delete TagBaselineDefinitionVersion.version
      • Delete TagBaselineDefinitionVersion.definition
      • Delete TagBaselineDefinitionVersion.details
      • Delete TagBaselineDefinitionVersion.predecessor
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete version
      • Delete definition
      • Delete details
      • Delete predecessor
  36. GET/v1/tag_baseline_version/item/{version_id} Get Tag Baseline Definition Version
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete version
      • Delete definition
      • Delete details
      • Delete predecessor
  37. GET/v1/tag_baseline_version/item/{version_id}/make-head Make Tag Baseline Definition Version the Head version
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete version
      • Delete definition
      • Delete details
      • Delete predecessor
  38. GET/v1/tag_baseline_version/item/{version_id}/make-release Make Tag Baseline Definition Version the Release version
    • Return Type
      • Delete sysId
      • Delete createdOn
      • Delete updatedOn
      • Delete version
      • Delete definition
      • Delete details
      • Delete predecessor
  39. POST/v1/tag_baselines/available_tags/list Returns a list of AvailableTags ids
    • Parameter
      • Add TagBaselineAvailableTagListRequest.filters.filters.resource_filter//Resources filter to filter (all if missing)
  40. 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.workload_id//Workload Id
      • Add TagPostureSummaryListRequest.filters.filter.resource_filter//Resources filter to filter (all if missing)
      • Change TagPostureSummaryListRequest.sort.column (Added Enum)
  41. 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.workload_id//Workload Id
      • Add TagPostureSummaryListRequest.filters.filter.resource_filter//Resources filter to filter (all if missing)
      • Change TagPostureSummaryListRequest.sort.column (Added Enum)
  42. GET/v1/user/switch_account/{master_account_id} Switch Master Account
    • Return Type
      • Add user.products//Products enabled in the master account
      • Delete alias//Alias details.
      • Delete workflow//Workflow details
      • Delete is_full_access//Whether full access or not.
      • Delete dashboard_reference//Dashboard reference.
      • Delete payment//Payment list.
      • Delete user_product_bundle_name//Project Bundle Name of the users.
      • Change user.crm_id
      • Change audit (Data Type)
  43. GET/v1/user_details Get User session and roles details
    • Return Type
      • Add user.products//Products enabled in the master account
      • Delete alias//Alias details.
      • Delete workflow//Workflow details
      • Delete is_full_access//Whether full access or not.
      • Delete dashboard_reference//Dashboard reference.
      • Delete payment//Payment list.
      • Delete user_product_bundle_name//Project Bundle Name of the users.
      • Change user.crm_id
      • Change audit (Data Type)
  44. POST/v1/well-architected-framework/assessment-definition/batch Get Dashboard Versions
    • Return Type
      • Delete sysId//ID of the Assessment Definition
      • Delete createdOn//Assessment Definition created on
      • Delete updatedOn//Assessment Definition updated on
      • Delete tenant_id//Tenant owning the assessment
      • Delete owner//Owner of the assessment
      • Delete approver//Approver of the assessment
      • Delete name//Name of the assessment
      • Delete description//Description of the assessment
      • Delete headVersion
      • Delete releaseVersion
      • Delete is_active//States if the assessment is active or not
      • Delete notification_configuration
  45. POST/v1/well-architected-framework/assessment-definition/create Create new Assessment
    • Return Type
      • Delete sysId//ID of the Assessment Definition
      • Delete createdOn//Assessment Definition created on
      • Delete updatedOn//Assessment Definition updated on
      • Delete tenant_id//Tenant owning the assessment
      • Delete owner//Owner of the assessment
      • Delete approver//Approver of the assessment
      • Delete name//Name of the assessment
      • Delete description//Description of the assessment
      • Delete headVersion
      • Delete releaseVersion
      • Delete is_active//States if the assessment is active or not
      • Delete notification_configuration
  46. GET/v1/well-architected-framework/assessment-definition/item/{assessment_id} Get Assessment Definition
    • Return Type
      • Delete sysId//ID of the Assessment Definition
      • Delete createdOn//Assessment Definition created on
      • Delete updatedOn//Assessment Definition updated on
      • Delete tenant_id//Tenant owning the assessment
      • Delete owner//Owner of the assessment
      • Delete approver//Approver of the assessment
      • Delete name//Name of the assessment
      • Delete description//Description of the assessment
      • Delete headVersion
      • Delete releaseVersion
      • Delete is_active//States if the assessment is active or not
      • Delete notification_configuration
  47. GET/v1/well-architected-framework/assessment-definition/item/{assessment_id}/history Get the history of an Assessment Definition
    • Return Type
      • Delete sysId//ID of the Assessment Definition Version
      • Delete createdOn//Assessment Version created on
      • Delete updatedOn//Assessment Version updated on
      • Delete version//Version number
      • Delete version_state//State of the version
      • Delete definition
      • Delete details
      • Delete predecessor
  48. POST/v1/well-architected-framework/assessment-definition/item/{assessment_id}/set-state Set state of Assessment Definition
    • Parameter
      • Delete WellArchitectedFrameworkAssessmentDefinition.sysId//ID of the Assessment Definition
      • Delete WellArchitectedFrameworkAssessmentDefinition.createdOn//Assessment Definition created on
      • Delete WellArchitectedFrameworkAssessmentDefinition.updatedOn//Assessment Definition updated on
      • Delete WellArchitectedFrameworkAssessmentDefinition.tenant_id//Tenant owning the assessment
      • Delete WellArchitectedFrameworkAssessmentDefinition.owner//Owner of the assessment
      • Delete WellArchitectedFrameworkAssessmentDefinition.approver//Approver of the assessment
      • Delete WellArchitectedFrameworkAssessmentDefinition.name//Name of the assessment
      • Delete WellArchitectedFrameworkAssessmentDefinition.description//Description of the assessment
      • Delete WellArchitectedFrameworkAssessmentDefinition.headVersion
      • Delete WellArchitectedFrameworkAssessmentDefinition.releaseVersion
      • Delete WellArchitectedFrameworkAssessmentDefinition.is_active//States if the assessment is active or not
      • Delete WellArchitectedFrameworkAssessmentDefinition.notification_configuration
    • Return Type
      • Delete sysId//ID of the Assessment Definition
      • Delete createdOn//Assessment Definition created on
      • Delete updatedOn//Assessment Definition updated on
      • Delete tenant_id//Tenant owning the assessment
      • Delete owner//Owner of the assessment
      • Delete approver//Approver of the assessment
      • Delete name//Name of the assessment
      • Delete description//Description of the assessment
      • Delete headVersion
      • Delete releaseVersion
      • Delete is_active//States if the assessment is active or not
      • Delete notification_configuration
  49. POST/v1/well-architected-framework/assessment-run-question/batch Get a batch of Assessment Run History Question details
    • Return Type
      • Add sync_failure_reason//Sync failure reason
      • Add answers.sync_failure_reason//Sync failure reason
  50. POST/v1/well-architected-framework/assessment-run/batch Get a batch of assessment run details
    • Return Type
      • Add sync_failure_reason//Sync failure reason
  51. POST/v1/well-architected-framework/assessment-run/create Start an assessment run for the assessment definition
    • Return Type
      • Add sync_failure_reason//Sync failure reason
  52. GET/v1/well-architected-framework/assessment-run/item/{assessment_run_id} Fetch the details for an assessment run by ID
    • Return Type
      • Add sync_failure_reason//Sync failure reason
  53. POST/v1/well-architected-framework/assessment-run/item/{assessment_run_id}/answer Answer a question or best practice
    • Parameter
      • Add WellArchitectedFrameworkAssessmentRunAnswerRequest.answer.sync_failure_reason//Sync failure reason
    • Return Type
      • Add sync_failure_reason//Sync failure reason
      • Add answers.sync_failure_reason//Sync failure reason
  54. POST/v1/well-architected-framework/assessment-run/item/{assessment_run_id}/set-state Set the state for an assessment run
    • Return Type
      • Add sync_failure_reason//Sync failure reason
  55. POST/v1/well-architected-framework/assessment-version/batch Get Assessment Versions
    • Return Type
      • Delete sysId//ID of the Assessment Definition Version
      • Delete createdOn//Assessment Version created on
      • Delete updatedOn//Assessment Version updated on
      • Delete version//Version number
      • Delete version_state//State of the version
      • Delete definition
      • Delete details
      • Delete predecessor
  56. POST/v1/well-architected-framework/assessment-version/create Create new Assessment Definition Version
    • Parameter
    • Delete WellArchitectedFrameworkAssessmentDefinitionVersion.sysId//ID of the Assessment Definition Version
      • Delete WellArchitectedFrameworkAssessmentDefinitionVersion.createdOn//Assessment Version created on
      • Delete WellArchitectedFrameworkAssessmentDefinitionVersion.updatedOn//Assessment Version updated on
      • Delete WellArchitectedFrameworkAssessmentDefinitionVersion.version//Version number
      • Delete WellArchitectedFrameworkAssessmentDefinitionVersion.version_state//State of the version
      • Delete WellArchitectedFrameworkAssessmentDefinitionVersion.definition
      • Delete WellArchitectedFrameworkAssessmentDefinitionVersion.details
      • Delete WellArchitectedFrameworkAssessmentDefinitionVersion.predecessor
    • Return Type
      • Delete sysId//ID of the Assessment Definition Version
      • Delete createdOn//Assessment Version created on
      • Delete updatedOn//Assessment Version updated on
      • Delete version//Version number
      • Delete version_state//State of the version
      • Delete definition
      • Delete details
      • Delete predecessor
  57. GET/v1/well-architected-framework/assessment-version/item/{version_id} Get Assessment Definition Version
    • Return Type
      • Delete sysId//ID of the Assessment Definition Version
      • Delete createdOn//Assessment Version created on
      • Delete updatedOn//Assessment Version updated on
      • Delete version//Version number
      • Delete version_state//State of the version
      • Delete definition
      • Delete details
      • Delete predecessor
  58. GET/v1/well-architected-framework/assessment-version/item/{version_id}/make-head Make Assessment Definition Version the Head version
    • Return Type
      • Delete sysId//ID of the Assessment Definition Version
      • Delete createdOn//Assessment Version created on
      • Delete updatedOn//Assessment Version updated on
      • Delete version//Version number
      • Delete version_state//State of the version
      • Delete definition
      • Delete details
      • Delete predecessor
  59. GET/v1/well-architected-framework/assessment-version/item/{version_id}/make-release Make Assessment Definition Version the Release version
    • Return Type
      • Delete sysId//ID of the Assessment Definition Version
      • Delete createdOn//Assessment Version created on
      • Delete updatedOn//Assessment Version updated on
      • Delete version//Version number
      • Delete version_state//State of the version
      • Delete definition
      • Delete details
      • Delete predecessor
  60. GET/v1/well-architected-framework/assessment-version/item/{version_id}/set-state Set state of Assessment Definition Version
    • Return Type
      • Delete sysId//ID of the Assessment Definition Version
      • Delete createdOn//Assessment Version created on
      • Delete updatedOn//Assessment Version updated on
      • Delete version//Version number
      • Delete version_state//State of the version
      • Delete definition
      • Delete details
      • Delete predecessor
  61. GET/v1/well-architected-framework/assessment/report/item/{report_id} Fetch an assessment run report by ID
    • Return Type
      • Add schedule_id//Schedule ID of which the report to be generated
      • Add email_recipients
  62. POST/v1/workload-definition/batch Get Dashboard Versions
    • Return Type
      • Delete sysId//ID of the Workload Definition
      • Delete createdOn//Workload Definition created on
      • Delete updatedOn//Workload Definition updated on
      • Delete tenant_id//Tenant owning the workload
      • Delete owner//Owner of the workload
      • Delete name//Name of the workload
      • Delete description//Description of the workload
      • Delete workload_type//Type of the workload
      • Delete headVersion
      • Delete releaseVersion
      • Delete is_active//States if the workload is active or not
      • Delete attachments//List of attachment IDs associated with this workload
  63. POST/v1/workload-definition/create Create new Workload
    • Return Type
      • Delete sysId//ID of the Workload Definition
      • Delete createdOn//Workload Definition created on
      • Delete updatedOn//Workload Definition updated on
      • Delete tenant_id//Tenant owning the workload
      • Delete owner//Owner of the workload
      • Delete name//Name of the workload
      • Delete description//Description of the workload
      • Delete workload_type//Type of the workload
      • Delete headVersion
      • Delete releaseVersion
      • Delete is_active//States if the workload is active or not
      • Delete attachments//List of attachment IDs associated with this workload
  64. GET/v1/workload-definition/item/{workload_id} Get Workload Definition
    • Return Type
      • Delete sysId//ID of the Workload Definition
      • Delete createdOn//Workload Definition created on
      • Delete updatedOn//Workload Definition updated on
      • Delete tenant_id//Tenant owning the workload
      • Delete owner//Owner of the workload
      • Delete name//Name of the workload
      • Delete description//Description of the workload
      • Delete workload_type//Type of the workload
      • Delete headVersion
      • Delete releaseVersion
      • Delete is_active//States if the workload is active or not
      • Delete attachments//List of attachment IDs associated with this workload
  65. GET/v1/workload-definition/item/{workload_id}/history Get the history of a Workload Definition
    • Return Type
      • Delete sysId//ID of the Workload Definition Version
      • Delete createdOn//Workload Definition Version created on
      • Delete updatedOn//Workload Definition Version updated on
      • Delete version//Version number
      • Delete definition
      • Delete details
      • Delete predecessor
  66. POST/v1/workload-definition/item/{workload_id}/set-state Set state of Workload Definition
    • Parameter
      • Delete WorkloadDefinition.sysId//ID of the Workload Definition
      • Delete WorkloadDefinition.createdOn//Workload Definition created on
      • Delete WorkloadDefinition.updatedOn//Workload Definition updated on
      • Delete WorkloadDefinition.tenant_id///Tenant owning the workload
      • Delete WorkloadDefinition.owner//Owner of the workload
      • Delete WorkloadDefinition.name//Name of the workload
      • Delete WorkloadDefinition.description//Description of the workload
      • Delete WorkloadDefinition.workload_type//Type of the workload
      • Delete WorkloadDefinition.headVersion
      • Delete WorkloadDefinition.releaseVersion
      • Delete WorkloadDefinition.is_active//States if the workload is active or not
      • Delete WorkloadDefinition.attachments//List of attachment IDs associated with this workload
    • Return Type
      • Delete sysId//ID of the Workload Definition
      • Delete createdOn//Workload Definition created on
      • Delete updatedOn//Workload Definition updated on
      • Delete tenant_id//Tenant owning the workload
      • Delete owner//Owner of the workload
      • Delete name//Name of the workload
      • Delete description//Description of the workload
      • Delete workload_type//Type of the workload
      • Delete headVersion
      • Delete releaseVersion
      • Delete is_active//States if the workload is active or not
      • Delete attachments//List of attachment IDs associated with this workload
  67. POST/v1/workload-definition/set-state-bulk Set state in Bulk for Workload Definition
    • Parameter
      • Delete payload.sysId//ID of the Workload Definition
      • Delete payload.createdOn//Workload Definition created on
      • Delete payload.updatedOn//Workload Definition updated on
      • Delete payload.tenant_id//Tenant owning the workload
      • Delete payload.owner//Owner of the workload
      • Delete payload.name//Name of the workload
      • Delete payload.description//Description of the workload
      • Delete payload.workload_type//Type of the workload
      • Delete payload.headVersion
      • Delete payload.releaseVersion
      • Delete payload.is_active//States if the workload is active or not
      • Delete payload.attachments//List of attachment IDs associated with this workload
    • Return Type
      • Delete sysId//ID of the Workload Definition
      • Delete createdOn//Workload Definition created on
      • Delete updatedOn//Workload Definition updated on
      • Delete tenant_id//Tenant owning the workload
      • Delete owner//Owner of the workload
      • Delete name//Name of the workload
      • Delete description//Description of the workload
      • Delete workload_type//Type of the workload
      • Delete headVersion
      • Delete releaseVersion
      • Delete is_active//States if the workload is active or not
      • Delete attachments//List of attachment IDs associated with this workload
  68. POST/v1/workload-version/batch Get Workload Versions
    • Return Type
      • Delete sysId//ID of the Workload Definition Version
      • Delete createdOn//Workload Definition Version created on
      • Delete updatedOn//Workload Definition Version updated on
      • Delete version//Version number
      • Delete definition
      • Delete details
      • Delete predecessor
  69. POST/v1/workload-version/create Create new Workload Definition Version
    • Parameter
      • Delete WorkloadDefinitionVersion.sysId//ID of the Workload Definition Version
      • Delete WorkloadDefinitionVersion.createdOn//Workload Definition Version created on
      • Delete WorkloadDefinitionVersion.updatedOn//Workload Definition Version updated on
      • Delete WorkloadDefinitionVersion.version//Version number
      • Delete WorkloadDefinitionVersion.definition
      • Delete WorkloadDefinitionVersion.details
      • Delete WorkloadDefinitionVersion.predecessor
    • Return Type
      • Delete sysId//ID of the Workload Definition Version
      • Delete createdOn//Workload Definition Version created on
      • Delete updatedOn//Workload Definition Version updated on
      • Delete version//Version number
      • Delete definition
      • Delete details
      • Delete predecessor
  70. GET/v1/workload-version/item/{version_id} Get Workload Definition Version
    • Return Type
      • Delete sysId//ID of the Workload Definition Version
      • Delete createdOn//Workload Definition Version created on
      • Delete updatedOn//Workload Definition Version updated on
      • Delete version//Version number
      • Delete definition
      • Delete details
      • Delete predecessor
  71. GET/v1/workload-version/item/{version_id}/make-head Make Workload Definition Version the Head version
    • Return Type
      • Delete sysId//ID of the Workload Definition Version
      • Delete createdOn//Workload Definition Version created on
      • Delete updatedOn//Workload Definition Version updated on
      • Delete version//Version number
      • Delete definition
      • Delete details
      • Delete predecessor
  72. GET/v1/workload-version/item/{version_id}/make-release Make Workload Definition Version the Release version
    • Return Type
      • Delete sysId//ID of the Workload Definition Version
      • Delete createdOn//Workload Definition Version created on
      • Delete updatedOn//Workload Definition Version updated on
      • Delete version//Version number
      • Delete definition
      • Delete details
      • Delete predecessor
  73. POST/v2/audit/auditlog/list Audit List
    • Parameter
      • Change AuditLogListRequest.filters.event_types
  74. POST/v2/service_account/create Create a new Service Account
    • Parameter
      • Add ServiceAccountDetails.onboarded_features.onboarded_by//Name of the user who onboarded the feature.
  75. GET/v2/service_account/item/{service_account_id} Get Service Account details
    • Return Type
      • Add onboarded_features.onboarded_by//Name of the user who onboarded the feature.
  76. POST/v2/service_account/item/{service_account_id} Update Service Account details
    • Parameter
      • Add ServiceAccountDetails.onboarded_features.onboarded_by//Name of the user who onboarded the feature.
    • Return Type
      • Add onboarded_features.onboarded_by//Name of the user who onboarded the feature.
  77. GET/v2/service_account/item/{service_account_id}/credentials_validation Validate Service Account Credentials
    • Return Type
      • Add onboarded_features.onboarded_by//Name of the user who onboarded the feature.
  78. POST/v2/service_account/item/{service_account_id}/dry_run Validate update of Service Account details
    • Parameter
      • Add ServiceAccountDetails.onboarded_features.onboarded_by//Name of the user who onboarded the feature.
    • Return Type
      • Add onboarded_features.onboarded_by//Name of the user who onboarded the feature.
  79. 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
      • Add ServiceAccountDetails.onboarded_features.onboarded_by//Name of the user who onboarded the feature.
    • Return Type
      • Add onboarded_features.onboarded_by//Name of the user who onboarded the feature.
  80. GET/v2/service_account/item/{service_account_id}/sync_status Get Current Sync Status
    • Return Type
      • Delete cloudops__log_analytics//Log Analytics Data current status
  81. POST/v2/service_account/item/{service_account_id}/sync_status Trigger refresh of Sync Status
    • Parameter
      • Delete ServiceAccountSync.cloudops__log_analytics//Log Analytics Data current status
    • Return Type
      • Delete cloudops__log_analytics//Log Analytics Data current status
  82. GET/v2/service_account/item/{service_account_id}/sync_status_history Get Sync Status History
    • Return Type
      • Delete cloudops__log_analytics//Log Analytics Data status history
  83. POST/v2/service_account/list List Service Accounts
    • Parameter
      • Add ServiceAccountListRequest.filters.only_restricted_cloud//Only include accounts in restricted datacenters
      • Add ServiceAccountListRequest.filters.exclude_restricted_cloud//Exclude all accounts in restricted datacenters
      • Delete ServiceAccountListRequest.filters.sync_status.cloudops__log_analytics//Log Analytics Data current status
  84. POST/v2/service_account/summary Summarize Service Accounts
    • Parameter
      • Add ServiceAccountSummaryRequest.filters.only_restricted_cloud//Only include accounts in restricted datacenters
      • Add ServiceAccountSummaryRequest.filters.exclude_restricted_cloud//Exclude all accounts in restricted datacenters
      • Delete ServiceAccountSummaryRequest.filters.sync_status.cloudops__log_analytics//Log Analytics Data current status

What's Coming in the Next Release (2404)?

What's Changing

  1. GET/operation/automation/template/{tenant_id}/jobs/list List Templates Jobs
  • Return Type
    • Delete jobs.incident_reference//Incident reference details.
  1. POST/operation/automation/templates/{tenant_id} Create Template
  • Parameter
    • Change CreateTemplateRequest.description
    • Change CreateTemplateRequest.type
  1. PUT/operation/automation/{tenant_id}/templates/{template_id} Update Template
  • Parameter
    • Change CreateTemplateRequest.description
    • Change CreateTemplateRequest.type
  1. POST/operation/automation/{tenant_id}/templates/{template_id}/execute Execute Template
  • Parameter
    • Delete TemplateExecuteRequest.incident_reference//Incident reference.
  1. POST/v1/admin/request_audit/list Returns a list of BackgroundJobs ids
  • Parameter
    • Change RequestAuditListRequest.sort.column (Removed Enum)
  1. POST/v1/master_accounts
  • Parameter
    • Delete CreateMasterAccountRequest.notification_settings.support_tool_account_id//Integrated Tool for support system
  1. GET/v1/master_accounts/item/{master_account_id} Master Account View
  • Return Type
    • Delete notification_settings.support_tool_account_id//Integrated Tool for support system
  1. PUT/v1/master_accounts/item/{master_account_id} Master Account Update
  • Parameter
    • Delete MasterAccountDetails.notification_settings.support_tool_account_id//Integrated Tool for support system
  • Return Type
    • Delete notification_settings.support_tool_account_id//Integrated Tool for support system

Updated 4 days ago