NSX-T Data Center REST API

Read Org Root

Read Org Root. Returns only the org root related properties. Inner object
are not populated.
For Hierarchical Get, base_path request parameter can be used.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/org-root
Request Headers:
n/a
Query Parameters:
ChildTypesRequestParameter+
Request Body:
n/a

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
OrgRoot+

Example Response:

Example 1: ---------- GET https://<policy-mgr>/policy/api/v1/org-root Response: { "resource_type": "OrgRoot", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" } Example 2: ---------- GET https://<policy-mgr>/policy/api/v1/org-root?base_path=/orgs/org-1 Response: { "resource_type": "OrgRoot", "children": [ { "Org": { "short_id": "org-1", "resource_type": "Org", "id": "org-1", "display_name": "org-1", "path": "/orgs/org-1", "relative_path": "org-1", "parent_path": "/orgs/org-1", "remote_path": "", "unique_id": "7fc5c60d-5862-43f3-9523-ca8bca50a3da", "realization_id": "7fc5c60d-5862-43f3-9523-ca8bca50a3da", "owner_id": "f45dfed4-f320-4109-ae4b-0b1d28dd875e", "children": [ { "Project": { "short_id": "kjfivYWD", "resource_type": "Project", "id": "project-1", "display_name": "project-1", "description": "This is test Project", "path": "/orgs/org-1/projects/project-1", "relative_path": "project-1", "parent_path": "/orgs/org-1", : : : }, "resource_type": "ChildProject", "id": "project-1", "marked_for_delete": false, "mark_for_override": false, "_protection": "NOT_PROTECTED" }, ], "marked_for_delete": false, "overridden": false, "_create_time": 1686152684351, "_create_user": "system", "_last_modified_time": 1686152684351, "_last_modified_user": "system", "_system_owned": true, "_protection": "NOT_PROTECTED", "_revision": 0 }, "resource_type": "ChildOrg", "marked_for_delete": false, "mark_for_override": false, "_protection": "NOT_PROTECTED" } ], "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }

Required Permissions:

read

Feature:

policy_org_root

Additional Errors: