v1

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

WellArchitectedFramework

Framework Update

Update a Well-Architected Framework

post/v1/well-architected-framework/{tenant_id}/framework/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

created_onstring date-time

Framework created on

created_bystring

Username who created the framework. null for Marketplace frameworks.

updated_onstring date-time

Framework updated on

updated_bystring

Username who updated the framework. null for Marketplace frameworks.

framework_idstring

ID of Framework

hyperscaler_framework_idstring

ID of framework

framework_type'Custom' | 'Marketplace'

Type of the Framework

account_idstring

Master account id associated with the framework. null for Marketplace frameworks

tenant_idstring

Tenant associated with the framework. null for Marketplace frameworks

namestring

Name of the Framework

descriptionstring

Description for Framework

versionstring

Version of the Framework

valid_service_typesstring[]

Valid Service Types

logostring

Logo of Framework

status'Draft' | 'Active' | 'Inactive'

Framework status

handle_none_of_the_above'No' | 'SeparateBP'

Defines the framework's handling of the None of the above option, with permissible values: No or SeparateBP

Example request

{
  "framework_type": "Custom",
  "valid_service_types": [
    "AWS"
  ],
  "status": "Draft",
  "handle_none_of_the_above": "No"
}

Response

Success