Sign in

v1

latestOpenAPI 3.0.0CoreStack Inc License2026-07-248001,5071.7 MB
WellArchitectedFramework

Best practice Update

Update Best Practice for a Well-Architected Framework Question

post/v1/well-architected-framework/{tenant_id}/best-practice/update

Path parameters

tenant_idstring required

Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.

Request body

framework_idstring

ID of the framework associated with the best practice

pillar_idstring

ID of the pillar associated with the best practice

question_idstring

ID for the question associated with the best practice

best_practice_idstring

ID for the best practice

hyperscaler_best_practice_idstring

ID of best practice

best_practicestring

Best practice at question level

descriptionstring

Statement of the best practice

recommendationstring

Statement of the best practice

nature'Automated' | 'Manual'

Nature of the best practice

risk'Low' | 'Medium' | 'High' | 'None'

Risk of the best practice

policy_urisstring[]

URIs of the Policies associated with this best practice

is_automatableboolean

Flag to indicate whether the best practice is automatable

is_none_of_the_aboveboolean

Flag to indicate whether the best practice is None of the above

Example request

{
  "nature": "Automated",
  "risk": "Low"
}

Response

Success

framework_idstring

ID of the framework associated with the best practice

pillar_idstring

ID of the pillar associated with the best practice

question_idstring

ID for the question associated with the best practice

best_practice_idstring

ID for the best practice

hyperscaler_best_practice_idstring

ID of best practice

best_practicestring

Best practice at question level

descriptionstring

Statement of the best practice

recommendationstring

Statement of the best practice

nature'Automated' | 'Manual'

Nature of the best practice

risk'Low' | 'Medium' | 'High' | 'None'

Risk of the best practice

policy_urisstring[]

URIs of the Policies associated with this best practice

is_automatableboolean

Flag to indicate whether the best practice is automatable

is_none_of_the_aboveboolean

Flag to indicate whether the best practice is None of the above

Example response

{
  "nature": "Automated",
  "risk": "Low"
}