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 ShareDelete 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 ShareIf 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 ShareIf 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 shareGet 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 ResourceDelete 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 resourceGet 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 ResourceIf 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 ResourceIf 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 RootRead 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 OrgPaginated list of Org. |
GET /policy/api/v1/orgs
|
Get OrgGet Org |
GET /policy/api/v1/orgs/{org-id}
|
List of PROJECTPaginated list of Project. |
GET /policy/api/v1/orgs/{org-id}/projects
|
Delete PROJECTDelete PROJECT. |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}
|
Get PROJECTGet PROJECT |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}
|
Create or update PROJECTIf 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 PROJECTUpdate 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}
|
Get quota detailsGet 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 projectGet 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 ProjectReturns the VC Folder Status on vCenter for the Project. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vc-folder-status
|
List of VPCPaginated list of VPC. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs
|
Delete VPC and its childrenDelete VPC. |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}
|
Get VPCGet VPC |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}
|
Create or update VPCIf a VPC with the vpc-id is not already present, create a new VPC. If it already exists, update the VPC. |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}
|
Update the VPCUpdate the VPC. |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}
|
List of VPC gateway policiesPaginated list of VPC gateway policies. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies
|
Delete Gateway PolicyDelete Gateway Policy. |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}
|
Get Gateway PolicyGet Gateway Policy |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}
|
Create or update Gateway PolicyIf a GatewayPolicy with the policy-id is not already present, create a new GatewayPolicy. If it already exists, update the GatewayPolicy. This is a full replace. |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}
|
Revise the positioning of VPC gateway policiesThis is used to set a precedence of a VPC gateway policy w.r.t others. |
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}?action=revise
|
Update the Gateway PolicyUpdate the Gateway Policy. |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}
|
List N-S Firewall RulesList N-S Firewall Rules GET /orgs/org1/projects/project1/vpcs/vpc-1/gateway-policies/default/rules |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}/rules
|
Delete N-S Firewall RuleDelete N-S Firewall Rule DELETE /orgs/org1/projects/project1/vpcs/vpc-1/gateway-policies/default/rules/rule-1 |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}
|
Read N-S Firewall RuleRead N-S Firewall Rule GET /orgs/org1/projects/project1/vpcs/vpc-1/gateway-policies/default/rules/rule-1 |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}
|
Patch N-S Firewall RulePatch the N-S Firewall Rule. If a Rule for the given Rule-id is not present, the object will get created and if it is present it will be updated. This is a full replace PATCH /orgs/org1/projects/project1/vpcs/vpc-1/gateway-policies/default/rules/rule-1 |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}
|
Revise the positioning of VPC N-S Firewall ruleThis is used to re-order a rule within a VPC gateway policy. |
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}?action=revise
|
Create or update N-S Firewall RuleUpdate the N-S Firewall Rule. If a Rule with the rule-id is not already present, this API fails with a 404. Creation of Rules is not allowed using this API. PUT /orgs/org1/projects/project1/vpcs/vpc-1/gateway-policies/default/rules/rule-1 |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}
|
Get rule statisticsGet statistics of N-S Firewall rule. - no enforcement point path specified: Stats will be evaluated on each enforcement point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}/statistics
|
Get gateway policy statisticsGet statistics of a gateway policy. - no enforcement point path specified: Stats will be evaluated on each enforcement point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}/statistics
|
Get groups for which the given object is a memberGet policy groups for which the given object is a member. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/group-associations
|
List VPC GroupsPaginated list of VPC Groups. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups
|
Delete VPC GroupDelete VPC Group. |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}
|
Get VPC GroupGet VPC Group |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}
|
Create or update VPC GroupIf a VPC group with the group-id is not already present, create a new VPC group. If it already exists, update the group. |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}
|
Create or update VPC GroupIf a VPC group with the group-id is not already present, create a new VPC group. If it already exists, update the VPC group. |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}
|
Get IP addresses that belong to this VPC GroupGet IP addresses that belong to this VPC Group. This API is applicable for Groups containing either VirtualMachine, VIF, Segment ,Segment Port or IP Address member type.For Groups containing other member types,an empty list is returned |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}/members/ip-addresses
|
Get subnet ports that belong to this VPC GroupGet subnet ports that belong to this VPC Group |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}/members/subnet-ports
|
Get subnets that belong to this VPC GroupGet subnets that belong to this VPC Group |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}/members/subnets
|
Get Virtual Network Interface instances that belong to this GroupGet Virtual Network Interface instances that belong to this Group. This API is applicable for Groups containing VirtualNetworkInterface and VirtualMachine member types. For Groups containing other member types,an empty list is returned. target_id in response is external_id of VirtualNetworkInterface or VirtualMachine. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}/members/vifs
|
Get Virtual machines that belong to this VPC GroupGet Virtual machines that belong to this VPC Group. This API is applicable for Groups containing VirtualMachine,member type. For Groups containing other member types,an empty list is returned. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}/members/virtual-machines
|
List VPC ip allocationsList all the ip allocations for a VPC. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-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}/vpcs/{vpc-id}/ip-address-allocations/{ip-address-allocation-id}
|
Get VPC ip allocation by IDGet detail information on VPC ip allocation by giving ID. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-address-allocations/{ip-address-allocation-id}
|
Patch a VPC ip allocationCreate a VPC ip allocation if it does not exist |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-address-allocations/{ip-address-allocation-id}
|
Create or update a VPC ip allocationCreate a VPC ip allocation if it does not exist |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-address-allocations/{ip-address-allocation-id}
|
Get groups for which the given IP address is a memberGet policy groups for which the given IP address is a member. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-address-group-associations
|
List Policy NAT types.List the two supported sections (USER and NAT64) under the given VPC ID. The USER section allows IPV4 based NAT rules, while the NAT64 rules allow translating IPV6 packets to IPV4 packets. For more details related to NAT section please refer to PolicyNAT schema. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat
|
GET Policy NAT types.Get either of the two supported sections (USER and NAT64) under the given VPC ID. The USER section allows IPV4 based NAT rules, while the NAT64 rules allow translating IPV6 packets to IPV4 packets. For more details related to NAT section please refer to PolicyNAT schema. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}
|
List NAT RulesList NAT Rules from VPC denoted by VPC ID, under NAT section denoted by <nat-id>. Under VPC there will be 2 different NATs(sections). (USER and NAT64) For more details related to NAT section please refer to PolicyNAT schema. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}/nat-rules
|
Delete NAT RuleDelete NAT Rule from VPC denoted by VPC ID, under NAT section denoted by <nat-id>. Under VPC there will be 2 different NATs(sections). (USER and NAT64) For more details related to NAT section please refer to PolicyNAT schema. |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Get NAT RuleGet NAT Rule from VPC denoted by VPC ID, under NAT section denoted by <nat-id>. Under VPC there will be 2 different NATs(sections). (USER and NAT64) For more details related to NAT section please refer to PolicyNAT schema. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Create or update a Nat RuleIf a NAT Rule is not already present on VPC denoted by VPC ID, under NAT section denoted by <nat-id>, create a new NAT Rule. If it already exists, update the NAT Rule. Under VPC there will be 2 different NATs(sections). (USER and NAT64) For more details related to NAT section please refer to PolicyNAT schema. |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Update NAT RuleUpdate NAT Rule on VPC denoted by VPC ID, under NAT section denoted by <nat-id>. Under VPC there will be 2 different NATs(sections). (USER and NAT64) For more details related to NAT section please refer to PolicyNAT schema. |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Get NAT Rule StatisticsGet NAT Rule Statistics from VPC denoted by VPC ID, under NAT section denoted by <nat-id>. Under VPC there will be 2 different NATs(sections). (USER and NAT64) For more details related to NAT section please refer to PolicyNAT schema. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics
|
List NAT Rules StatisticsList NAT Rules Statistics from VPC denoted by VPC ID. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/statistics
|
Get quota detailsGet quota details |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/quota-stats
|
List of VPC security policiesPaginated list of VPC security policies. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies
|
Delete SecurityPolicyDelete SecurityPolicy. |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}
|
Get SecurityPolicyGet SecurityPolicy |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}
|
Create or update SecurityPolicyIf a SecurityPolicy with the policy-id is not already present, create a new SecurityPolicy. If it already exists, update the SecurityPolicy. This is a full replace. |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}
|
Revise the positioning of VPC security policiesThis is used to set a precedence of a VPC security policy w.r.t others. |
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}?action=revise
|
Update the SecurityPolicyUpdate the SecurityPolicy. |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}
|
List E-W Firewall RulesList Rules GET /orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules
|
Delete E-W Firewall RuleDelete E-W Firewall Rule DELETE /orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules/rule-1 |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules/{rule-id}
|
Read E-W Firewall RuleRead Rule GET /orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules/rule-1 |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules/{rule-id}
|
Patch E-W Firewall RulePatch the E-W Firewall Rule. If a Rule for the given Rule-id is not present, the object will get created and if it is present it will be updated. This is a full replace PATCH /orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules/rule-1 |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules/{rule-id}
|
Revise the positioning of VPC E-W Firewall ruleThis is used to re-order a rule within a VPC security policy. |
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules/{rule-id}?action=revise
|
Create or update E-W Firewall RuleUpdate the E-W Firewall Rule. If a Rule with the rule-id is not already present, this API fails with a 404. Creation of Rules is not allowed using this API. PUT /orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules/rule-1 |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules/{rule-id}
|
Get rule statisticsGet statistics of E-W Firewall rule. - no enforcement point path specified: Stats will be evaluated on each enforcement point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules/{rule-id}/statistics
|
Get security policy statisticsGet statistics of a security policy. - no enforcement point path specified: Stats will be evaluated on each enforcement point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/statistics
|
Get resources shared with a given vpcGet 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
|
List VPC Static RoutesPaginated list of all VPC Static Routes |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/static-routes
|
Delete VPC static routesDelete VPC static routes |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/static-routes/{route-id}
|
Read VPC static routesRead VPC static routes |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/static-routes/{route-id}
|
Create or update a VPC static routesIf static routes for route-id are not already present, create static routes. If it already exists, update static routes for route-id. |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/static-routes/{route-id}
|
Create or update a VPC static routesIf static routes for route-id are not already present, create static routes. If it already exists, replace the static routes for route-id. |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/static-routes/{route-id}
|
Get VPC Statistics SummaryGet VPC Statistics Summary |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/statistics/summary
|
List of VPC SubnetPaginated list of VPC Subnet. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets
|
Delete VPC SubnetDelete VPC Subnet. |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}
|
Get VPC SubnetGet VPC Subnet |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}
|
Create or update VPC SubnetIf a VPC Subnet with the subnet-id is not already present, create a new VPC Subnet. If it already exists, update the VPC Subnet. |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}
|
Update the VPC SubnetUpdate the VPC Subnet. |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}
|
Read VPC Subnet DHCP server statisticsRead VPC Subnet DHCP server statistics along with ip pool usage information. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-server-config/stats
|
Read Vpc Subnet DHCP server statusRead Vpc Subnet DHCP server status |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-server-config/status
|
List all VPC Subnet DHCP static bindingsPaginated list of all VPC Subnet DHCP static binding instances |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-static-binding-configs
|
Delete VPC Subnet DHCP static bindingDelete VPC Subnet DHCP static binding |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-static-binding-configs/{binding-id}
|
Read VPC Subnet DHCP static bindingRead VPC Subnet DHCP static binding |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-static-binding-configs/{binding-id}
|
Create or update VPC Subnet DHCP static bindingIf binding with the binding-id is not already present, create a new VPC Subnet DHCP static binding instance. If it already exists, replace the existing VPC Subnet DHCP static binding instance with specified attributes. |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-static-binding-configs/{binding-id}
|
Create or update VPC Subnet DHCP static bindingIf binding with the binding-id is not already present, create a new VPC Subnet DHCP static binding instance. If it already exists, replace the existing VPC Subnet DHCP static binding instance with this object. |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-static-binding-configs/{binding-id}
|
Get statistics for downlink router portGet statistics for downlink router port |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/gateway-interface-statistics/summary
|
List IpAddressPools of VPC Subnet.Paginated list of IpAddressPools of VPC Subnet. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools
|
Read an IpAddressPool of VPC Subnet.Read IpAddressPool with given Id. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools/{ip-pool-id}
|
List VPC Subnet ip allocationsList all the ip allocations for a VPC Subnet. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools/{ip-pool-id}/ip-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}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
|
Get VPC Subnet ip allocation by IDGet detail information on VPC Subnet ip allocation by giving ID. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
|
Patch a VPC Subnet ip_allocationsCreate a VPC Subnet ip-allocation if it does not exist based on the IDs, or update existing ip-allocation |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
|
Create or update a VPC Subnet ip allocationCreate a VPC Subnet ip allocation if it does not exist based on the IDs, or update existing ip-allocation information by replacing the port object already exists. |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
|
List VPC Subnet PortsList all the ports for a VPC Subnet. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports
|
Delete a VPC Subnet PortDelete a VPC Subnet Port by giving ID. |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}
|
Get VPC Subnet Port by IDGet detail information on VPC Subnet Port by giving ID. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}
|
Patch a VPC Subnet PortCreate a VPC Subnet port if it does not exist based on the IDs, or update existing port information by replacing the port object fields which presents in the request body. |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}
|
Create or update a VPC Subnet PortCreate a VPC Subnet port if it does not exist based on the IDs, or update existing port information by replacing the port object already exists. |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}
|
Get MAC table for VPC Subnet portReturns MAC table for a VPC Subnet port |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}/mac-table
|
Get VPC Subnet port MAC table in CSVReturns MAC table for a VPC Subnet port |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}/mac-table/csv
|
Get VPC Subnet port stateReturns VPC Subnet port state on enforcement point |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}/state
|
Get VPC Subnet statistics informationGet VPC Subnet statistics information. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/statistics
|
Get VPC Subnet statusGet VPC Subnet status Provides status of the VPC subnet as well as network information such as gateway address, subnet mask, dhcp server address, dhcp range, static ip pools, static ip pool range. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/status
|
List all unique tags.Returns paginated list of all unique tags. Supports filtering by scope, tag and source from which tags are synced. Supports starts with, ends with, equals and contains operators on scope and tag values. To filter tags by starts with on scope or tag, use '*' as suffix after the value. To filter tags by ends with on scope or tag, use '*' as prefix before the value. To filter tags by contain on scope or tag, use '*' as prefix and suffix on the value. Below special characters in the filter value needs to be escaped with hex values. - Character '&' needs to be escaped as '%26' - Character '[' needs to be escaped as '%5B' - Character ']' needs to be escaped as '%5D' - Character '+' needs to be escaped as '%2B' - Character '#' needs to be escaped as '%23' Sort option for list of unique tags is available only on tag and scope properties. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/tags
|
List all objects assigned with matching scope and tag valuesPaginated list of all objects assigned with matching scope and tag values. Objects are represented in form of resource reference. Sort option is available only on target_type and target_display_name properties. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/tags/effective-resources
|
Get details of tag bulk operation requestGet details of tag bulk operation request with which tag is applied or removed on virtual machines. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/tags/vpc-tag-operations/{operation-id}
|
Assign or Unassign tag on multiple Virtual Machines.Tag can be assigned or unassigned on multiple objects. Supported object type is restricted to Virtual Machine for now and support for other objects will be added later. Permissions for tag bulk operation would be similar to virtual machine tag permissions. |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/tags/vpc-tag-operations/{operation-id}
|
Get status of tag bulk operationGet status of tag bulk operation with details of tag operation on each virtual machine. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/tags/vpc-tag-operations/{operation-id}/status
|
VC Folder Status for VpcReturns the VC Folder Status on vCenter for the Vpc. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vc-folder-status
|
Get groups for which the given VM is a memberGet policy groups for which the given VM is a member. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/virtual-machine-group-associations
|
List all virtual machines for this VPCThis API lists the Virtual Machines for this VPC. Only those VMs are listed which are connected to the subnets of this VPC. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/virtual-machines
|
Apply tags on virtual machine under VPCAllows an admin to apply multiple tags to a virtual machine under VPC. This operation does not store the intent on the policy side. It applies the tag directly on the specified enforcement point. This operation will replace the existing tags on the virtual machine with the ones that have been passed. If the application of tag fails on the enforcement point, then an error is reported. The admin will have to retry the operation again. Policy framework does not perform a retry. Failure could occur due to multiple reasons. For e.g enforcement point is down, Enforcement point could not apply the tag due to constraints like max tags limit exceeded, etc. NOTE: The "virtual_machine_id" field in the payload will be ignored and the virtual machine ID provided in the URL will be honored. |
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/virtual-machines/{virtual-machine-id}/tags
|
Get groups for which the given VIF is a memberGet policy groups for which the given VIF is a member. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/virtual-network-interface-group-associations
|
Get resources shared with a given orgGet the list of resource shared with a given org. |
GET /policy/api/v1/orgs/{org-id}/shared-with-me
|