NSX-T Data Center REST API

Associated URIs:

API Description	API Path
List shares	GET /policy/api/v1/infra/shares GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/shares
Delete Share Delete a Share.	DELETE /policy/api/v1/infra/shares/{share-id} DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/shares/{share-id}
Get single instance of a share	GET /policy/api/v1/infra/shares/{share-id} GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/shares/{share-id}
Create or update a Share If a Share with the given ID already exists, update the share entity.	PATCH /policy/api/v1/infra/shares/{share-id} PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/shares/{share-id}
Create or update a Share If a Share with the given ID already exists, and the revision is 0, throw error	PUT /policy/api/v1/infra/shares/{share-id} PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/shares/{share-id}
Get Shared resource list for a given share Get the list of shared resource in a given share.	GET /policy/api/v1/infra/shares/{share-id}/resources GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/shares/{share-id}/resources
Delete Shared Resource Delete Shared Resource.	DELETE /policy/api/v1/infra/shares/{share-id}/resources/{shared-resource-id} DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/shares/{share-id}/resources/{shared-resource-id}
Get Shared resource Get the shared resource that represents shared objects.	GET /policy/api/v1/infra/shares/{share-id}/resources/{shared-resource-id} GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/shares/{share-id}/resources/{shared-resource-id}
Create or update Shared Resource If Shared resource already exists, update the shared resource entity. User Presence of the shared resource denotes sharing of the parent object.	PATCH /policy/api/v1/infra/shares/{share-id}/resources/{shared-resource-id} PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/shares/{share-id}/resources/{shared-resource-id}
Create or update Shared Resource If Shared resource already exists, update the shared resource entity. User Presence of the shared resource denotes sharing of the parent object.	PUT /policy/api/v1/infra/shares/{share-id}/resources/{shared-resource-id} PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/shares/{share-id}/resources/{shared-resource-id}
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.	GET /policy/api/v1/org-root
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.	PATCH /policy/api/v1/org-root
List of Org Paginated list of Org.	GET /policy/api/v1/orgs
Get Org Get Org	GET /policy/api/v1/orgs/{org-id}
List of PROJECT Paginated list of Project.	GET /policy/api/v1/orgs/{org-id}/projects
Delete PROJECT Delete PROJECT.	DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}
Get PROJECT Get PROJECT	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}
Create or update PROJECT If a Project with the project-id is not already present, create a new Project. If it already exists, update the Project.	PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}
Update the PROJECT Update the Project. For local Project, local transport zone and edge clusters needs to be added.	PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}
List Project ip allocations List all the ip allocations for a Project.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/ip-address-allocations
Records intent to release an IP from an IpPool. Releases the IP that was allocated for this allocation request	DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/ip-address-allocations/{ip-address-allocation-id}
Get Project ip allocation by ID Get detail information on Project ip allocation by giving ID.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/ip-address-allocations/{ip-address-allocation-id}
Patch a Project ip allocation Create a Project ip allocation if it does not exist	PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/ip-address-allocations/{ip-address-allocation-id}
Create or update a project ip allocation If a Project IP Address Allocation is absent, create a new one. If it already exists, replace the Project IP Address Allocation instance with the new object.	PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/ip-address-allocations/{ip-address-allocation-id}
Get quota details Get quota details To create, update, list and delete the Quota, please refer to Constraint APIs with 'constraint_expressions' as 'EntityInstanceCountConstraintExpression'.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/quota-stats
Get resources shared with a given project Get the list of resource shared with a given project.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/shared-with-me
VC Folder Status for Project Returns the VC Folder Status on vCenter for the Project.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vc-folder-status
Get quota details Get quota details	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/quota-stats
Get resources shared with a given vpc Get the list of resource shared with a given vpc.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/shared-with-me
Get resources shared with a given org Get the list of resource shared with a given org.	GET /policy/api/v1/orgs/{org-id}/shared-with-me