NSX-T Data Center REST API
Update on org-root to update all the nested entities using HAPI.
Patch API at org-root to create/update/delete entire or part of intent hierarchy.Hierarchical API: Provides users a way to create entire or part of
intent in single API invocation. Input is expressed in a tree format.
Each node in tree can have multiple children of different types.
System will resolve the dependecies of nodes within the intent tree
and will create the model. Children for any node can be specified using
ChildResourceReference or ChildPolicyConfigResource.
If a resource is specified using ChildResourceReference then it will
not be updated only its children will be updated. If Object is specified
using ChildPolicyConfigResource, object along with its children will be
updated.
Hierarchical API can also be used to delete any sub-branch of entire tree.
Request:
Method:
PATCH
URI Path(s):
/policy/api/v1/org-root
Request Headers:
n/a
Query Parameters:
ForceRevisionCheckRequestParameter+
Request Body:
OrgRoot+
Example Request:
{ "resource_type": "OrgRoot", "children": [ { "resource_type": "ChildResourceReference", "id": "default", "target_type": "Org", "children": [ { "resource_type": "ChildProject", "Project": { "id": "project-1", "resource_type": "Project", "display_name": "Test HAPI Project", "site_infos": [ { "edge_cluster_paths": [ "/infra/sites/default/enforcement-points/default/edge-clusters/ec1" ], "site_path": "/infra/sites/default" } ], "tier_0s": [ "/infra/tier-0s/pepsi" ] } } ] } ] }Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a